AgencyZoom

agencyzoom

AgencyZoom is for the P&C insurance agent that's looking to increase sales, boost retention and analyze agency & producer performance.

CRM Analytics Web del proveedor

Acciones

Triggers

Autenticación

—

OAuth gestionado

Información técnica: el detalle de parámetros, schemas y triggers de esta página está pensado para equipos de integración. Si solo necesitas saber si tu herramienta favorita está disponible, basta con ver la lista de acciones.

Acciones disponibles (99)

Cada acción es una operación que el agente puede ejecutar contra este conector. Haz clic en una acción para ver sus parámetros.

Authenticate for JWT via V4 SSOAGENCYZOOM_AUTHENTICATE_FOR_JWTVIA_V4_SSOAcción

Authenticates a user via v4 single sign-on (sso) using the provided callback `code` (typically required for success) to retrieve a jwt and initial user session information.

Parámetros de entrada

codestring
Callback code from the V4SSO authentication process to finalize the SSO handshake and retrieve a JWT.

Parámetros de salida

dataobjectObligatorio
Contains the JWT and owner agent status after successful authentication.
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Batch create contactsAGENCYZOOM_BATCH_CREATE_CONTACTAcción

Creates 1 to 5 new contacts in agencyzoom in a single batch api call.

Parámetros de entrada

contactDataRequestsobject[]
A list of contact data objects, each defining a new contact to be created. Up to 5 contacts can be included in a single request.

Parámetros de salida

dataobjectObligatorio
Contains the detailed result of the batch contact creation process.
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Batch create leadsAGENCYZOOM_BATCH_CREATE_LEADAcción

Creates up to 5 new leads in agencyzoom; all referenced entity ids (e.g., pipeline, user, custom field names) must exist, and organization `name` is required if `isbusiness` is true.

Parámetros de entrada

leadDataRequestsobject[]
List of lead data objects. A maximum of 5 leads can be created per request.

Parámetros de salida

dataobjectObligatorio
Result of the batch lead creation, including success status and messages.
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Batch delete tasksAGENCYZOOM_BATCH_DELETE_TASKAcción

Deletes multiple agencyzoom tasks in a batch; task deletion is permanent and the response indicates overall batch success, not individual task status.

Parámetros de entrada

taskIdsinteger[]
List of unique numerical identifiers for the tasks to be deleted.

Parámetros de salida

dataobjectObligatorio
Contains details regarding the outcome of the batch task deletion request.
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Change lead statusAGENCYZOOM_CHANGE_STATUS_FOR_LEADAcción

Updates a lead's lifecycle status (e.g., active, won, lost, x-dated) and can optionally manage its workflow, pipeline, stage, source, or associated tags.

Parámetros de entrada

datestring
Date for the status change. If status is 5 (XDATED), this is the reactivation date (e.g., 'YYYY-MM-DD'); otherwise, it can be contact or quoted date.
leadIdintegerObligatorio
Unique identifier of the lead to be updated (path parameter).
statusintegerObligatorio
New status for the lead: 0 (ACTIVE), 2 (WON), 3 (LOST), 5 (XDATED).
tagIdsinteger[]
List of tag IDs to associate with the lead.
toStageIdinteger
ID of a specific workflow stage for direct assignment, irrespective of recycling.
xDateTypestring
Type or reason for the X-date, used if status is 5 (XDATED) (e.g., a predefined X-date recycle event name).
workflowIdinteger
Identifier of the workflow to associate; if provided, the lead moves to this workflow.
lossReasonIdinteger
Identifier for the loss reason. Recommended if status is 3 (LOST).
recycleToStageinteger
ID of the stage to move the lead to if it is being recycled.
workflowStageIdinteger
Identifier of the stage within the specified workflow to move the lead to.
recycleToPipelineinteger
ID of the pipeline to move the lead to if it is being recycled.
changeLeadSourceTointeger
Identifier for a new lead source to assign, updating the lead's origin.

Parámetros de salida

dataobjectObligatorio
Response data including success status, message, and the ID of the updated lead.
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Mark task as completedAGENCYZOOM_COMPLETE_TASKAcción

Marks an existing and accessible task in agencyzoom as 'completed'; this action does not return the full updated task object.

Parámetros de entrada

taskIdintegerObligatorio
Unique identifier of the task to be marked as completed.

Parámetros de salida

dataobjectObligatorio
Outcome of the task completion, including success indicator, task ID, and optional message.
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Create a customer noteAGENCYZOOM_CREATE_A_CUSTOMER_NOTEAcción

Adds a new note to an existing customer's profile using their id; cannot be used to edit or retrieve existing notes.

Parámetros de entrada

notestringObligatorio
The textual content of the note to be added to the customer's profile.
customerIdintegerObligatorio
The unique identifier of the customer to whom the note will be added.

Parámetros de salida

dataobjectObligatorio
Contains the details of the created note, including its ID and a confirmation message.
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Create a driver for an opportunityAGENCYZOOM_CREATE_A_DRIVER_FOR_AN_OPPORTUNITYAcción

Creates a new driver record associated with an existing agencyzoom opportunity using its id; full driver details are handled by the api endpoint directly, not specified in this action's request.

Parámetros de entrada

opportunityIdintegerObligatorio
The unique identifier of the opportunity to which the new driver will be associated.

Parámetros de salida

dataobjectObligatorio
Contains the result of the driver creation operation, including the new driver's ID and a status message.
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Create a lead noteAGENCYZOOM_CREATE_A_LEAD_NOTEAcción

Adds a new note to an existing lead in agencyzoom, identified by `leadid`.

Parámetros de entrada

notestringObligatorio
Textual content of the note to be created for the lead.
leadIdintegerObligatorio
Unique identifier of the lead to associate the note with.

Parámetros de salida

dataobjectObligatorio
Contains the details of the created note, including its ID and a confirmation message.
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Create a lead opportunityAGENCYZOOM_CREATE_A_LEAD_OPPORTUNITYAcción

Adds a new sales opportunity to an existing lead in agencyzoom, requiring a valid `leadid`, `carrierid`, `productlineid`, and that custom field names match existing definitions in agencyzoom.

Parámetros de entrada

itemsinteger
Number of items in this opportunity (e.g., number of vehicles for auto policy). Defaults to 1.
leadIdintegerObligatorio
The unique identifier of the existing lead to which this opportunity will be added.
premiumintegerObligatorio
The estimated or actual premium amount for this opportunity.
carrierIdintegerObligatorio
The unique identifier of the insurance carrier associated with this opportunity.
customFieldsobject[]
Custom fields to associate with this opportunity. `fieldName` must match a pre-defined field. Date-type `fieldValue` must be 'MM/dd/YYYY'.
productLineIdintegerObligatorio
The unique identifier of the product line (e.g., Auto, Home, Life) for this opportunity.

Parámetros de salida

dataobjectObligatorio
Contains the detailed response from the server, including any messages, the new opportunity's ID, and success status.
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Create a lead quoteAGENCYZOOM_CREATE_A_LEAD_QUOTEAcción

Creates a new insurance quote for an existing lead in agencyzoom, using valid carrier and product line ids, to track a proposal; this action does not bind policies or process payments.

Parámetros de entrada

itemsintegerObligatorio
Number of items or units covered (e.g., vehicles for an auto policy); meaning may vary by product line.
leadIdintegerObligatorio
Unique identifier of the lead for this quote.
premiumintegerObligatorio
Total premium amount in the smallest currency unit (e.g., cents for USD: 125075 means $1250.75).
carrierIdintegerObligatorio
Unique identifier of the insurance carrier.
customFieldsobject[]
Optional list of custom fields and their values.
productLineIdintegerObligatorio
Unique identifier of the product line (e.g., Auto, Home).

Parámetros de salida

dataobjectObligatorio
Details of the created lead quote, including ID and status.
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Create an opportunityAGENCYZOOM_CREATE_AN_OPPORTUNITYAcción

Creates a new lead opportunity in agencyzoom; this action cannot update existing opportunities.

Parámetros de entrada

itemsinteger
The number of items related to this opportunity, such as number of policies or vehicles.
premiuminteger
The premium amount for the opportunity.
carrierIdinteger
Identifier for the insurance carrier associated with the opportunity.
expiryDatestring
The expiration date of the policy or opportunity, in MM/dd/YYYY format.
customFieldsobject[]
A list of custom field objects to associate with the opportunity. If a custom field's value is a date, it must be in MM/dd/YYYY format.
productLineIdintegerObligatorio
Identifier for the policy type (product line) of the opportunity.
property__zipstring
The ZIP code for the property associated with the opportunity.
property__citystring
The city name for the property, e.g., Monticello.
property__statestring
The state code for the property, e.g., FL for Florida.
property__countrystring
The country code for the property, e.g., USA.
customerReferralIdintegerObligatorio
Identifier for the lead associated with this opportunity.
property__address1string
Primary street address line for the property.
property__address2string
Secondary street address line for the property (e.g., apartment, suite, unit number).
property__useMailingAddressAsLocationinteger
Indicates if the lead's mailing address is used as the property location (1 for true, 0 for false). The API defaults to 1 (true) if not specified, using the lead's address for the opportunity's property.

Parámetros de salida

dataobjectObligatorio
The response payload containing details of the creation attempt, including the new opportunity's ID, a message, and a success flag.
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Create a vehicle for an opportunityAGENCYZOOM_CREATE_A_VEHICLE_FOR_AN_OPPORTUNITYAcción

Adds a new vehicle record to a specified opportunity; `opportunityid` must refer to a valid, existing opportunity.

Parámetros de entrada

vinstring
Vehicle Identification Number (VIN); typically 17 characters.
makestringObligatorio
Manufacturer of the vehicle (e.g., Toyota, Ford).
yearinteger
Manufacturing year of the vehicle (e.g., 2023).
modelstring
Model of the vehicle (e.g., Camry, Civic).
ownershipstringenum
Ownership status. Defaults to 'Owned' if not provided.
FinancedLeasedOwned
opportunityIdintegerObligatorio
Identifier of the opportunity to associate the vehicle with.

Parámetros de salida

dataobjectObligatorio
Result of vehicle creation, including new vehicle ID and success status.
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Create business leadAGENCYZOOM_CREATE_BIZ_LEADAcción

Creates or updates a business lead in agencyzoom using detailed personal and company information, for b2b sales and marketing lead management.

Parámetros de entrada

Sin parámetros.

Parámetros de salida

dataobjectObligatorio
Details of the operation outcome, including lead ID and status messages.
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Create leadAGENCYZOOM_CREATE_LEADAcción

Creates a new lead or updates an existing one in agencyzoom; ensure `pipelineid`, `stageid`, `leadsourceid`, and `assignto` reference valid, existing entities.

Parámetros de entrada

zipstring
The postal code or ZIP code of the lead's address.
citystring
The city of the lead's address.
namestring
The name of the organization or company, required if 'isBusiness' is True.
csrIdinteger
The unique identifier of the Customer Service Representative (CSR) assigned to the lead.
emailstringObligatorio
The primary email address of the lead.
notesstring
Additional notes or comments about the lead.
phonestring
The primary phone number of the lead.
statestring
The state or province of the lead's address (e.g., CA, TX, NY).
xDatestring
The X-date (e.g., policy expiration or renewal date) associated with the lead, preferably in YYYY-MM-DD format.
countrystringObligatorio
The country of the lead's address (e.g., US, CA).
stageIdintegerObligatorio
The unique identifier of the stage within the specified pipeline where the lead will be placed.
assignTostringObligatorio
The unique identifier (ID) of the producer or agent to whom the lead is assigned.
birthdaystring
The lead's date of birth, in MM/DD/YY format.
lastnamestring
The last name of the lead.
nicknamestring
An informal name or nickname for the lead.
soldDatestring
The date when the lead was marked as sold, preferably in YYYY-MM-DD format.
tagNamesstring
A single string containing multiple tag names, separated by semicolons (;). These tags help categorize or segment the lead.
firstnamestringObligatorio
The first name of the lead.
groupCodestring
The group code associated with the lead, if applicable.
otherCsrsinteger[]
A list of unique identifiers for other Customer Service Representatives (CSRs) also assigned to or associated with this lead.
quoteDatestring
The date when a quote was provided to the lead, preferably in YYYY-MM-DD format.
isBusinessboolean
Indicates whether the lead is a business entity (True) or an individual consumer (False).
middlenamestring
The middle name of the lead.
pipelineIdintegerObligatorio
The unique identifier of the sales pipeline to which the lead will be added.
contactDatestring
The date of the last contact with the lead, preferably in YYYY-MM-DD format.
agencyNumberstring
The agency location code associated with the lead, if applicable.
customFieldsobject[]
A list of custom field objects, each specifying a field name and its value(s) for the lead.
leadSourceIdintegerObligatorio
The unique identifier of the lead source (e.g., 'Website', 'Referral').
maritalStatusinteger
An integer code representing the lead's marital status. The specific mapping of integers to statuses (e.g., 1 for Single, 2 for Married) should be confirmed within your AgencyZoom system configuration or API documentation.
streetAddressstring
The primary street address of the lead.
departmentCodestring
The department code associated with the lead, if applicable.
otherProducersinteger[]
A list of unique identifiers for other producers or agents also assigned to or associated with this lead.
secondaryEmailstring
An alternative or secondary email address for the lead.
secondaryPhonestring
An alternative or secondary phone number for the lead.
assignmentGroupIdinteger
The unique identifier of the assignment group responsible for the lead.
nextExpirationDatestring
The next important expiration date related to the lead (e.g., current policy expiration), in MM/DD/YY format.
streetAddressLine2string
Additional street address information (e.g., apartment, suite, or unit number).

Parámetros de salida

dataobjectObligatorio
Contains the result of the lead creation or update operation, including the lead's ID and a status message.
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Create task post endpointAGENCYZOOM_CREATE_TASKAcción

Creates a new task in agencyzoom; ensure `assigneeid`, `customerid`, or `leadid` are valid existing entities if provided, and use `contactemail`, `customerid`, or `leadid` to link the task to a contact.

Parámetros de entrada

typestringenum
Task type ('call', 'email', 'meeting', 'todo'); highly recommended.
callemailmeetingtodo
titlestring
Title or name of the task; highly recommended for identification.
leadIdinteger
Unique ID of an existing lead to link to this task; must be an existing lead if provided.
commentsstring
Additional notes, comments, or description for the task.
durationinteger
Expected task duration in minutes, typically for 'call' or 'meeting' types.
inviteesstring[]
List of email addresses for invitees, typically for 'meeting' type tasks.
assigneeIdinteger
Unique ID of the AgencyZoom user to assign the task; must be an existing user if provided.
customerIdinteger
Unique ID of an existing customer to link to this task; must be an existing customer if provided.
dueDatetimestring
Due date and time, preferably in ISO 8601 format (e.g., 'YYYY-MM-DDTHH:MM:SSZ').
contactEmailstring
Email of the customer/lead to associate with the task; used if `customerId` or `leadId` is not provided.
timeSpecificboolean
If `True`, the time in `dueDatetime` is specific; otherwise, task is due anytime on `dueDatetime`'s date.
lifeProfessionalIdinteger
Unique ID of the Life & Health Professional for this task, for specific insurance workflows.

Parámetros de salida

dataobjectObligatorio
Data returned upon task creation: new task's ID, result flag, and optional message.
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Delete a customerAGENCYZOOM_DELETE_A_CUSTOMERAcción

Irreversibly deletes a customer and all associated data in agencyzoom using their `customerid`; useful for offboarding or data privacy compliance.

Parámetros de entrada

customerIdintegerObligatorio
The unique numerical identifier of the customer record to be permanently deleted.

Parámetros de salida

dataobjectObligatorio
The payload containing detailed results of the customer deletion attempt, including a status message, the ID of the customer processed, and a success indicator.
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Delete customer fileAGENCYZOOM_DELETE_A_CUSTOMER_FILEAcción

Permanently deletes a specific file, identified by `fileid`, associated with a customer, identified by `customerid`.

Parámetros de entrada

fileIdintegerObligatorio
The unique identifier for the file to be deleted from the specified customer's record.
customerIdintegerObligatorio
The unique identifier for the customer whose file is to be deleted.

Parámetros de salida

dataobjectObligatorio
Contains the details of the deletion operation's result.
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Delete a customer policyAGENCYZOOM_DELETE_A_CUSTOMER_POLICYAcción

Permanently deletes a specific policy associated with a customer, for instance, if it's cancelled or inactive; this action is irreversible and requires caution.

Parámetros de entrada

policyIdintegerObligatorio
The unique identifier of the policy to be deleted from the specified customer's account.
customerIdintegerObligatorio
The unique identifier of the customer whose policy is to be deleted.

Parámetros de salida

dataobjectObligatorio
Contains the outcome of the delete operation, including a success flag and an optional message.
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Delete an opportunity driver by IDAGENCYZOOM_DELETE_A_DRIVERAcción

Permanently deletes an existing agencyzoom driver (e.g., lead, potential sale, or business engagement) using its valid `driverid`; this action is irreversible.

Parámetros de entrada

driverIdintegerObligatorio
The unique identifier of the driver record to be deleted.

Parámetros de salida

dataobjectObligatorio
Contains the details of the deletion operation's outcome.
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Delete file from leadAGENCYZOOM_DELETE_A_LEAD_FILEAcción

Deletes a specific file (identified by `fileid`) associated with an existing lead (identified by `leadid`); this operation is irreversible.

Parámetros de entrada

fileIdintegerObligatorio
The unique identifier for the file that needs to be deleted from the specified lead.
leadIdintegerObligatorio
The unique identifier for the lead whose file is to be deleted.

Parámetros de salida

dataobjectObligatorio
The structured response from the API, containing details about the outcome of the file deletion.
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Delete a lead opportunityAGENCYZOOM_DELETE_A_LEAD_OPPORTUNITYAcción

Permanently deletes an existing opportunity (by `opportunityid`) associated with an existing lead (by `leadid`) when it's irrelevant, closed, or erroneous; the lead itself remains.

Parámetros de entrada

leadIdintegerObligatorio
The unique identifier for the lead whose opportunity is to be deleted.
opportunityIdintegerObligatorio
The unique identifier for the opportunity to be deleted.

Parámetros de salida

dataobjectObligatorio
Contains the result of the delete operation, including a success flag, an optional message, and the ID of the deleted opportunity.
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Delete a lead quoteAGENCYZOOM_DELETE_A_LEAD_QUOTEAcción

Deletes a specific quote from a lead, requiring that the lead and quote exist and are associated.

Parámetros de entrada

leadIdintegerObligatorio
Unique identifier of the lead.
quoteIdintegerObligatorio
Unique identifier of the quote to be deleted.

Parámetros de salida

dataobjectObligatorio
Container for the detailed outcome of the lead quote deletion.
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Delete an opportunityAGENCYZOOM_DELETE_AN_OPPORTUNITYAcción

Permanently deletes a specific opportunity by its unique id; this action is irreversible and requires a valid, existing `opportunityid`.

Parámetros de entrada

opportunityIdintegerObligatorio
The unique identifier of the opportunity to be deleted.

Parámetros de salida

dataobjectObligatorio
Contains the details of the deletion attempt, including success status and any messages.
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Delete a taskAGENCYZOOM_DELETE_A_TASKAcción

Permanently and irreversibly deletes an existing task, identified by its `taskid`.

Parámetros de entrada

taskIdintegerObligatorio
Unique identifier of the task to delete.

Parámetros de salida

dataobjectObligatorio
Details of the deletion operation's outcome.
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Delete a vehicleAGENCYZOOM_DELETE_A_VEHICLEAcción

Permanently deletes a vehicle record by its `vehicleid`, which must correspond to an existing vehicle in the agencyzoom system.

Parámetros de entrada

vehicleIdintegerObligatorio
Unique identifier of the vehicle to be deleted.

Parámetros de salida

dataobjectObligatorio
Detailed result of the vehicle deletion, including success status, targeted vehicle ID, and optional message.
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Delete thread messageAGENCYZOOM_DELETE_MESSAGEAcción

Deletes a specific message from an email thread within agencyzoom, where the message id is implicitly handled (e.g., via url path or session) as the request schema is empty.

Parámetros de entrada

Sin parámetros.

Parámetros de salida

dataobjectObligatorio
Contains the result of the delete operation, typically including the updated message thread information.
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Delete email threadAGENCYZOOM_DELETE_THREADAcción

Permanently deletes a specific email thread from the agencyzoom system, identified by its `threadid` (expected by the endpoint), provided the thread exists.

Parámetros de entrada

Sin parámetros.

Parámetros de salida

dataobjectObligatorio
Detailed result of the delete operation, including a confirmation message, optional ID, and success status.
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Get a list of assign groupsAGENCYZOOM_GET_A_LIST_OF_ASSIGN_GROUPSAcción

Retrieves all assign groups configured in agencyzoom, used for categorizing or assigning items to specific teams or units.

Parámetros de entrada

Sin parámetros.

Parámetros de salida

dataobject[]Obligatorio
A list of assign groups. Each group object in the list contains an 'id' and 'name'.
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Get a list of carriersAGENCYZOOM_GET_A_LIST_OF_CARRIERSAcción

Retrieves all insurance carriers from agencyzoom, typically used for populating selection lists or synchronizing carrier data; does not return detailed policy or coverage information.

Parámetros de entrada

Sin parámetros.

Parámetros de salida

dataobject[]Obligatorio
A list of insurance carriers.
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Get a list of CSRsAGENCYZOOM_GET_A_LIST_OF_CSRSAcción

Fetches all customer service representatives (csrs), including their id and name, returning an empty list if none are configured.

Parámetros de entrada

Sin parámetros.

Parámetros de salida

dataobjectObligatorio
Contains the list of CSRs.
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Get a list of custom fieldsAGENCYZOOM_GET_A_LIST_OF_CUSTOM_FIELDSAcción

Retrieves metadata for all configured custom field definitions, not the specific values entered for individual records.

Parámetros de entrada

Sin parámetros.

Parámetros de salida

dataobject[]Obligatorio
A list of custom field definitions.
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Get a list of drivers for an opportunityAGENCYZOOM_GET_A_LIST_OF_DRIVERS_FOR_AN_OPPORTUNITYAcción

Retrieves a list of drivers (individuals), including their personal details, licensing information, and relationship status, associated with a specific, existing `opportunityid` in agencyzoom.

Parámetros de entrada

opportunityIdintegerObligatorio
Unique identifier of the opportunity.

Parámetros de salida

dataobject[]Obligatorio
List of drivers associated with the opportunity.
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Get a list of employeesAGENCYZOOM_GET_A_LIST_OF_EMPLOYEESAcción

Retrieves a complete list of all employees for the authenticated agency; returns an empty list if no employees are configured.

Parámetros de entrada

Sin parámetros.

Parámetros de salida

dataobject[]Obligatorio
A list of employee records, where each record includes detailed information about an employee.
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Get lead source categoriesAGENCYZOOM_GET_A_LIST_OF_LEAD_SOURCE_CATEGORIESAcción

Retrieves a comprehensive list of all predefined lead source categories from agencyzoom, used to classify lead origins.

Parámetros de entrada

Sin parámetros.

Parámetros de salida

dataobject[]Obligatorio
A list of available lead source categories, each with an ID and name.
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Get lead sourcesAGENCYZOOM_GET_A_LIST_OF_LEAD_SOURCESAcción

Fetches a list of all lead sources configured in agencyzoom, including their id, name, sales exclusion status, and category id.

Parámetros de entrada

Sin parámetros.

Parámetros de salida

dataobject[]Obligatorio
List of all available lead source objects.
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Get a list of life professionalsAGENCYZOOM_GET_A_LIST_OF_LIFE_PROFESSIONALSAcción

Retrieves a list of life insurance professionals, including only their contact and status information (excluding sales or customer data), from the agencyzoom platform.

Parámetros de entrada

Sin parámetros.

Parámetros de salida

dataobject[]Obligatorio
Contains a list of life professional objects, each detailing a professional's information.
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Get a list of locationsAGENCYZOOM_GET_A_LIST_OF_LOCATIONSAcción

Retrieves all agency locations or branches from agencyzoom; filtering options are not available.

Parámetros de entrada

Sin parámetros.

Parámetros de salida

dataobject[]Obligatorio
A list of location objects, each detailing an agency branch or office.
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Get loss reasonsAGENCYZOOM_GET_A_LIST_OF_LOSS_REASONSAcción

Retrieves a list of all predefined loss reasons from agencyzoom, used for populating ui elements or analysis, returning all reasons without filtering or statistical data.

Parámetros de entrada

Sin parámetros.

Parámetros de salida

dataobject[]Obligatorio
A list of available loss reasons, where each reason includes an 'id' and a 'name'.
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Get a list of pipelinesAGENCYZOOM_GET_A_LIST_OF_PIPELINESAcción

Retrieves all pipelines and their stages from agencyzoom to understand workflow structures; this is a read-only operation and does not return individual items (like leads or tasks) within these pipelines.

Parámetros de entrada

Sin parámetros.

Parámetros de salida

dataobject[]Obligatorio
Pipelines, each detailing its ID, name, type, sequence, status, and associated stages.
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Get a list of producersAGENCYZOOM_GET_A_LIST_OF_PRODUCERAcción

Retrieves a list of all producers from agencyzoom, typically related to text thread functionalities.

Parámetros de entrada

Sin parámetros.

Parámetros de salida

dataobjectObligatorio
Primary data payload of the response.
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Get product lines and policy typesAGENCYZOOM_GET_A_LIST_OF_PRODUCT_LINES_POLICY_TYPESAcción

Fetches all product lines and policy types from agencyzoom, each detailed with its id, name, and product category id.

Parámetros de entrada

Sin parámetros.

Parámetros de salida

dataobject[]Obligatorio
A list of available product lines or policy types, each including its ID, name, and associated product category ID.
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Get a list of recycle eventsAGENCYZOOM_GET_A_LIST_OF_RECYCLE_EVENTSAcción

Retrieves the history of recycling activities (e.g., reassignments, status changes, x-date updates) for a specified existing lead in agencyzoom.

Parámetros de entrada

leadIdintegerObligatorio
The unique identifier of the lead for which to retrieve recycle events.

Parámetros de salida

dataobjectObligatorio
Contains lists of existing and new X-Dates related to the lead's recycle events.
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Retrieve vehicles for opportunityAGENCYZOOM_GET_A_LIST_OF_VEHICLES_FOR_AN_OPPORTUNITYAcción

Retrieves all vehicles associated with an existing opportunity, using its unique opportunityid.

Parámetros de entrada

opportunityIdintegerObligatorio
Unique identifier for the opportunity, used to retrieve its associated vehicles.

Parámetros de salida

dataobject[]Obligatorio
List of vehicles associated with the specified opportunity.
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Get AMS policies for a customerAGENCYZOOM_GET_AMS_POLICIES_FOR_A_CUSTOMERAcción

Retrieves a customer's synchronized agency management system (ams) policy data (typically a single policy); requires an active ams integration, may return empty/default values if data is missing.

Parámetros de entrada

customerIdintegerObligatorio
Unique identifier for the customer whose AMS policy data is to be retrieved.

Parámetros de salida

dataobjectObligatorio
Contains the detailed information for an AMS policy associated with the customer.
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Get auth URL for V4 SSOAGENCYZOOM_GET_AUTH_URL_FOR_V4_SSOAcción

Retrieves a fresh authentication url for agencyzoom's v4 single sign-on (sso) process; call before each sso attempt as the url may change and should not be cached.

Parámetros de entrada

Sin parámetros.

Parámetros de salida

dataobjectObligatorio
Details for V4 SSO authentication.
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Get departments groupsAGENCYZOOM_GET_DEPARTMENTS_GROUPSAcción

Fetches department and group information for an agency, optionally filtered by a specific `agencynumber`, to analyze its organizational structure.

Parámetros de entrada

agencyNumberstring
The unique identifier for the agency. If provided, fetches departments and groups for this specific agency.

Parámetros de salida

dataobjectObligatorio
Contains the lists of departments and groups for the queried agency.
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Get lead filesAGENCYZOOM_GET_LEAD_FILESAcción

Retrieves metadata for files linked to leads; sends an empty post request, which typically fetches a default set of files (not full lead details) for existing leads with documents.

Parámetros de entrada

Sin parámetros.

Parámetros de salida

dataobject[]Obligatorio
A list of objects, where each object contains metadata for a file associated with a lead.
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Retrieve notes for specific leadAGENCYZOOM_GET_LEAD_NOTESAcción

Fetches the complete history of notes for a specific lead by `leadid` (which must exist), useful for reviewing context for communications or follow-ups; this is a read-only operation.

Parámetros de entrada

leadIdintegerObligatorio
The unique identifier of the lead for whom notes are to be retrieved.

Parámetros de salida

dataobject[]Obligatorio
A list of notes associated with the specified lead.
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Get lead quotesAGENCYZOOM_GET_LEAD_QUOTESAcción

Retrieves all insurance quotes (active and inactive) for a specific lead id, useful for reviewing or tracking quote history.

Parámetros de entrada

leadIdintegerObligatorio
The unique identifier for the lead whose quotes are to be retrieved.

Parámetros de salida

dataobject[]Obligatorio
A list of quotes associated with the specified lead.
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Get lead tasksAGENCYZOOM_GET_LEAD_TASKSAcción

Retrieves all tasks for a specific lead, identified by its `leadid`, to review its activity history or manage follow-ups.

Parámetros de entrada

leadIdintegerObligatorio
The unique identifier for the lead whose tasks are to be retrieved.

Parámetros de salida

dataobject[]Obligatorio
A list of tasks associated with the specified lead.
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Get list of end stagesAGENCYZOOM_GET_LIST_OF_END_STAGESAcción

Fetches a list of all defined end stages, representing final steps in processes like lead conversion or policy closure.

Parámetros de entrada

Sin parámetros.

Parámetros de salida

dataobject[]Obligatorio
A list detailing each end stage in a workflow or pipeline.
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Get policies for a customerAGENCYZOOM_GET_POLICIES_FOR_A_CUSTOMERAcción

Retrieves from agencyzoom details for an insurance policy of an existing customer (identified by `customerid`), excluding premium payment history or claims information.

Parámetros de entrada

customerIdintegerObligatorio
Unique identifier for the customer.

Parámetros de salida

dataobjectObligatorio
Detailed attributes of the retrieved insurance policy.
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Get the customer detailsAGENCYZOOM_GET_THE_CUSTOMER_DETAILSAcción

Fetches comprehensive details for a specific customer, including personal information, policies, notes, tasks, files, and custom fields, using their unique customer id.

Parámetros de entrada

customerIdintegerObligatorio
Unique identifier of the customer to retrieve details for.

Parámetros de salida

dataobjectObligatorio
Contains the detailed information for the requested customer.
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Get the customer tasksAGENCYZOOM_GET_THE_CUSTOMER_TASKSAcción

Fetches all tasks (read-only task data) for a customer by `customerid` to review their activities, follow-ups, and action items; the `customerid` must be valid.

Parámetros de entrada

customerIdintegerObligatorio
Unique identifier for the customer whose tasks are to be retrieved.

Parámetros de salida

dataobject[]Obligatorio
A list of task objects associated with the specified customer.
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Get the driver detailsAGENCYZOOM_GET_THE_DRIVER_DETAILSAcción

Retrieves detailed information for a specific, existing driver (by `driverid`) associated with an agencyzoom opportunity.

Parámetros de entrada

driverIdintegerObligatorio
The unique identifier of the driver whose details are to be retrieved.

Parámetros de salida

dataobjectObligatorio
Contains the detailed information for the requested driver.
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Get the lead detailsAGENCYZOOM_GET_THE_LEAD_DETAILSAcción

Retrieves comprehensive details for a specific lead in agencyzoom by its unique `leadid` (which must correspond to an existing lead), including contact information, status, associated opportunities, quotes/policies, custom fields, and interaction history.

Parámetros de entrada

leadIdintegerObligatorio
Unique identifier for the lead whose details are to be retrieved.

Parámetros de salida

dataobjectObligatorio
Contains the detailed information for the requested lead.
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Get the opportunities for a leadAGENCYZOOM_GET_THE_OPPORTUNITIES_FOR_A_LEADAcción

Retrieves all sales opportunities and their details for a specified, existing `leadid` in agencyzoom.

Parámetros de entrada

leadIdintegerObligatorio
The unique identifier of the lead for which opportunities are to be fetched.

Parámetros de salida

dataobject[]Obligatorio
A list of opportunity objects, each detailing an opportunity associated with the lead.
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Get the opportunity detailsAGENCYZOOM_GET_THE_OPPORTUNITY_DETAILSAcción

Fetches comprehensive details for an existing opportunity using its unique `opportunityid`.

Parámetros de entrada

opportunityIdintegerObligatorio
The unique identifier for the opportunity to retrieve.

Parámetros de salida

dataobjectObligatorio
Contains the detailed information for the retrieved opportunity.
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Get the task detailsAGENCYZOOM_GET_THE_TASK_DETAILSAcción

Retrieves comprehensive details for a specific task using its unique `taskid`, which must correspond to an existing task in agencyzoom.

Parámetros de entrada

taskIdintegerObligatorio
Unique identifier of the task to retrieve.

Parámetros de salida

dataobjectObligatorio
Object containing the detailed information of the retrieved task.
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Get the vehicle detailsAGENCYZOOM_GET_THE_VEHICLE_DETAILSAcción

Retrieves detailed information for a specific vehicle, often associated with an agencyzoom opportunity, using its unique vehicleid.

Parámetros de entrada

vehicleIdintegerObligatorio
Unique identifier for the vehicle, often linked to an opportunity within AgencyZoom.

Parámetros de salida

dataobjectObligatorio
Detailed information of the requested vehicle.
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Get thread detailsAGENCYZOOM_GET_THREAD_DETAILSAcción

Searches and retrieves detailed information for email threads in agencyzoom; no explicit search criteria are passed in this request.

Parámetros de entrada

Sin parámetros.

Parámetros de salida

dataobjectObligatorio
Contains the retrieved email thread details, including messages and count.
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Link a driver to opportunityAGENCYZOOM_LINK_A_DRIVER_TO_OPPORTUNITYAcción

Assigns or reassigns an existing driver to an existing opportunity.

Parámetros de entrada

driverIdintegerObligatorio
The unique identifier for the existing driver (e.g., sales agent, team member) who will be linked to the opportunity.
opportunityIdintegerObligatorio
The unique identifier for the existing opportunity to which the driver will be linked.

Parámetros de salida

dataobjectObligatorio
The structured data returned by the API, detailing the outcome of the link operation.
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Link vehicle to opportunityAGENCYZOOM_LINK_A_VEHICLE_TO_OPPORTUNITYAcción

Links an existing vehicle to an existing sales opportunity in agencyzoom using their respective ids, typically for managing auto insurance policies or related services.

Parámetros de entrada

vehicleIdintegerObligatorio
Identifier of the vehicle to be linked to the opportunity.
opportunityIdintegerObligatorio
Identifier of the opportunity to which the vehicle will be linked.

Parámetros de salida

dataobjectObligatorio
Contains the details of the operation's outcome, including a success flag, an optional message, and an optional ID.
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

List Product CategoriesAGENCYZOOM_LIST_PRODUCT_CATEGORIESAcción

Retrieves a complete, unfiltered list of all product categories (id and name) from agencyzoom, useful for understanding product organization or populating ui elements.

Parámetros de entrada

Sin parámetros.

Parámetros de salida

dataobject[]Obligatorio
List of product categories, each with its unique ID and name.
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Log the user inAGENCYZOOM_LOG_THE_USER_INAcción

Authenticates an existing agencyzoom user using their email (as username) and password to obtain a jwt for api access; this action does not support new user creation.

Parámetros de entrada

passwordstringObligatorio
The user's password for authentication.
usernamestringObligatorio
The user's email address, used as the username for authentication.

Parámetros de salida

dataobjectObligatorio
Contains the authentication token and user status details.
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Log the user outAGENCYZOOM_LOG_THE_USER_OUTAcción

Use this action to log the current user out of agencyzoom by invalidating their active session token.

Parámetros de entrada

Sin parámetros.

Parámetros de salida

dataobjectObligatorio
The structured response data from the logout operation, indicating success and any relevant messages.
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Mark thread as unreadAGENCYZOOM_MARK_THREAD_AS_UNREAD_API_ENDPOINTAcción

Marks a text thread in agencyzoom as read or unread using its `threadid`; this action does not modify message content and the specified `threadid` must refer to an existing thread.

Parámetros de entrada

threadIdstring
The unique identifier of the text thread whose read/unread status is to be updated.
markUnreadboolean
Set to `true` to mark the thread as unread, or `false` to mark it as read.

Parámetros de salida

dataobjectObligatorio
Contains the result of the operation, including the processed thread's ID and the success status.
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Move lead to soldAGENCYZOOM_MOVE_LEAD_TO_SOLDAcción

Marks an existing lead as sold by its `leadid` and records product details; `productlineid`, `premium`, `effectivedate`, and `solddate` are operationally required for each sold product, despite schema flexibility.

Parámetros de entrada

leadIdintegerObligatorio
Identifier of the lead to be marked as sold.
keepOpenboolean
If true, lead remains open after products are marked sold (e.g., for other potential sales). Defaults to false.
soldProductsobject[]Obligatorio
List of products sold to the lead.

Parámetros de salida

dataobjectObligatorio
Details of the customer and opportunities after the lead is marked sold.
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Remove text threadAGENCYZOOM_REMOVE_TEXT_THREAD_ENDPOINTAcción

Call this action to permanently delete a text thread in agencyzoom; the target thread is identified by the api via implicit context as this action accepts no parameters.

Parámetros de entrada

Sin parámetros.

Parámetros de salida

dataobjectObligatorio
The structured response data returned by the API after the delete operation.
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Reopen a taskAGENCYZOOM_REOPEN_A_TASKAcción

Reopens an existing agencyzoom task that is currently 'completed' or 'closed', allowing it to be reactivated with optional comments.

Parámetros de entrada

taskIdintegerObligatorio
The unique identifier of the task to be reopened.
commentsstring
Optional comments providing context or reasons for reopening the task.

Parámetros de salida

dataobjectObligatorio
Contains the outcome of the reopen operation, including a success indicator, an optional message, and the ID of the reopened task.
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Search business classificationsAGENCYZOOM_SEARCH_BUSINESS_CLASSIFICATIONSAcción

Retrieves a comprehensive list of all available business classifications from agencyzoom, each including an id, code, and description.

Parámetros de entrada

Sin parámetros.

Parámetros de salida

dataobject[]Obligatorio
The list of business classifications retrieved by the action.
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Search customersAGENCYZOOM_SEARCH_CUSTOMERSAcción

Searches for customers in agencyzoom using criteria like contact information, policy details, or custom fields, with options for filtering, sorting, and pagination.

Parámetros de entrada

Sin parámetros.

Parámetros de salida

dataobjectObligatorio
The main data object of the response, containing the list of customers and pagination details.
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Search email threadsAGENCYZOOM_SEARCH_EMAIL_THREADSAcción

Retrieves a list of email thread metadata from agencyzoom, suitable for an overview when no specific filtering, sorting, or pagination is needed, as results are subject to default server-side limits and ordering.

Parámetros de entrada

Sin parámetros.

Parámetros de salida

dataobjectObligatorio
Contains the list of email thread information.
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Search leadsAGENCYZOOM_SEARCH_LEADSAcción

Retrieves agencyzoom leads, using filters, pagination, and sorting options sent in the post body, as the request schema itself is empty.

Parámetros de entrada

Sin parámetros.

Parámetros de salida

dataobjectObligatorio
Detailed response: list of leads, pagination info, and total counts.
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Search leads countAGENCYZOOM_SEARCH_LEADS_COUNTAcción

Retrieves a summary of lead counts categorized by workflow stage from agencyzoom; this action does not support filtering and returns aggregate counts rather than individual lead details.

Parámetros de entrada

Sin parámetros.

Parámetros de salida

dataobjectObligatorio
Primary response payload containing `leadsCount`, a list of lead counts per workflow stage.
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Search life and health leadsAGENCYZOOM_SEARCH_LIFE_AND_HEALTH_LEADSAcción

Searches for life and health insurance leads by providing filter criteria (matching alrlead fields) in the request body; an empty request may retrieve all leads or a default set.

Parámetros de entrada

Sin parámetros.

Parámetros de salida

dataobjectObligatorio
Response with search results: list of leads and pagination details.
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Search SMS threadsAGENCYZOOM_SEARCH_SMS_THREADSAcción

Searches and retrieves sms threads from agencyzoom, with search parameters, filters, sorting, and pagination typically provided in the request body of this post operation.

Parámetros de entrada

Sin parámetros.

Parámetros de salida

dataobjectObligatorio
Primary data payload encapsulating the list of SMS threads.
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Search and list tasksAGENCYZOOM_SEARCH_TASKSAcción

Searches and lists tasks, supporting pagination and accepting filter criteria in the post request body despite an empty request schema.

Parámetros de entrada

Sin parámetros.

Parámetros de salida

dataobjectObligatorio
Paginated list of tasks and metadata from the search.
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

List service ticketsAGENCYZOOM_SERVICE_TICKET_LISTAcción

Retrieves a list of service tickets from agencyzoom, optionally filtered by criteria such as status, priority, or date ranges.

Parámetros de entrada

Sin parámetros.

Parámetros de salida

dataobjectObligatorio
Contains the paginated list of service tickets and total count.
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Get text thread detailsAGENCYZOOM_TEXT_DETAIL_THREADAcción

Retrieves detailed messages for an implicitly specified text thread.

Parámetros de entrada

Sin parámetros.

Parámetros de salida

dataobjectObligatorio
Contains the detailed information for the text thread, including messages and their count.
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Unlink driver from opportunityAGENCYZOOM_UNLINK_A_DRIVER_FROM_OPPORTUNITYAcción

Unlinks a currently associated driver from an agencyzoom opportunity, used when the driver is no longer relevant, for policy or data updates, potentially impacting the opportunity's status or associated policy details.

Parámetros de entrada

driverIdintegerObligatorio
Identifier for the driver to be unlinked from the opportunity.
opportunityIdintegerObligatorio
Identifier for the opportunity from which the driver will be unlinked.

Parámetros de salida

dataobjectObligatorio
Contains the detailed result of the unlinking operation, including a status message, an optional ID, and a success indicator.
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Unlink vehicle from opportunityAGENCYZOOM_UNLINK_A_VEHICLE_FROM_OPPORTUNITYAcción

Unlinks a specific, existing vehicle from a specific, existing opportunity using their respective ids, removing only the association and not the records themselves.

Parámetros de entrada

vehicleIdintegerObligatorio
The unique identifier of the vehicle to be unlinked from the specified opportunity.
opportunityIdintegerObligatorio
The unique identifier of the opportunity from which the vehicle will be unlinked.

Parámetros de salida

dataobjectObligatorio
The structured response data containing details about the unlink operation's outcome.
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Unread email threadAGENCYZOOM_UNREAD_THREADAcción

Updates the read or unread status of a specific email thread within agencyzoom.

Parámetros de entrada

threadIdstring
The unique identifier of the email thread whose read status is to be updated.
markUnreadboolean
Set to true to mark the thread as unread, or false to mark it as read.

Parámetros de salida

dataobjectObligatorio
The response body containing the outcome of the mark as unread/read operation.
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Update a driver's detailsAGENCYZOOM_UPDATE_A_DRIVER_S_DETAILSAcción

Updates an existing driver's details in agencyzoom, requiring `driverid` in the path and `firstname` and `lastname` in the request.

Parámetros de entrada

genderstringenum
Gender of the driver. Valid values are: "M" (Male), "F" (Female), "U" (Unknown), "X" (Non-Binary).
FMUX
birthdaystring
The date of birth of the driver. Must be in MM/DD/YYYY format.
driverIdintegerObligatorio
The unique identifier for the opportunity driver whose details are to be updated.
lastNamestringObligatorio
The last name of the driver.
firstNamestringObligatorio
The first name of the driver.
middleNamestring
The middle name of the driver.
relationshipstringenum
Relationship status of the driver. Valid values are: "IN" (Named Insured), "SP" (Spouse), "PA" (Parent), "CH" (Child), "OT" (Other).
CHINOTPASP
licenseNumberstring
The driver's license number.
maritalStatusinteger
Marital status of the driver, represented by an integer code. Valid codes are: 1 (Single), 2 (Married), 3 (Widowed), 4 (Separated), 5 (Divorced), 6 (Domestic Partner), 7 (Civil Union), 8 (Fiancé / Fiancée), 9 (Unknown), 10 (Other).
stateLicensedstring
The state where the driver is licensed, using its two-letter abbreviation (e.g., NY for New York).

Parámetros de salida

dataobjectObligatorio
Contains the details of the update operation's outcome, including a message, ID, and result status.
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Rename lead fileAGENCYZOOM_UPDATE_A_LEAD_FILE_NAMEAcción

Updates a lead's file name to `newfilename`; requires `fileid` of the target file, which must be associated with both the `leadid` (path parameter) and the provided `customerreferralid`.

Parámetros de entrada

fileIdinteger
The unique identifier of the file to be renamed.
leadIdintegerObligatorio
The unique identifier of the lead whose file needs to be renamed.
newFileNamestring
The desired new name for the file.
customerReferralIdinteger
The identifier of the customer referral associated with the lead file.

Parámetros de salida

dataobjectObligatorio
Contains the outcome of the file renaming operation, including a success flag and an optional message.
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Update a lead opportunityAGENCYZOOM_UPDATE_A_LEAD_OPPORTUNITYAcción

Updates an existing opportunity's details (carrier, product line, premium, items, custom fields) for a specific lead; `leadid`, opportunity `id`, `carrierid`, and `productlineid` must refer to existing entities.

Parámetros de entrada

idintegerObligatorio
Unique identifier of the opportunity to update.
itemsinteger
Number of items associated with this opportunity (e.g., policies, vehicles).
leadIdintegerObligatorio
Unique identifier of the lead.
premiumintegerObligatorio
The premium amount for this opportunity. It is recommended to use the base currency unit (e.g., USD). Please verify the exact currency and format (e.g., cents or dollars) with AgencyZoom's API documentation.
carrierIdintegerObligatorio
Unique identifier of the insurance carrier.
customFieldsobject[]
A list of custom fields to update for the opportunity. For date-type custom fields, ensure the value is formatted as 'MM/DD/YYYY'.
productLineIdintegerObligatorio
Unique identifier of the product line.

Parámetros de salida

dataobjectObligatorio
Details of the update operation's result.
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Update lead quote dataAGENCYZOOM_UPDATE_A_LEAD_QUOTEAcción

Updates an existing quote for a specified lead in agencyzoom when its details require revision, ensuring the provided `leadid` (path parameter), quote `id` (body parameter), `carrierid`, and `productlineid` are valid and correspond to existing entities.

Parámetros de entrada

idintegerObligatorio
The unique identifier of the quote to be updated.
itemsintegerObligatorio
The number of items covered by the quote (e.g., number of vehicles in an auto policy).
leadIdintegerObligatorio
The unique identifier of the lead for which the quote is being updated. This is a path parameter.
premiumintegerObligatorio
The total premium amount for the quote, in cents (e.g., 10000 for $100.00).
carrierIdintegerObligatorio
The unique identifier of the insurance carrier associated with this quote.
customFieldsobject[]
A list of custom field objects to update for the quote. Each object should specify the `fieldName` and its corresponding `fieldValue`.
productLineIdintegerObligatorio
The unique identifier of the product line (e.g., Auto, Home) for this quote.

Parámetros de salida

dataobjectObligatorio
Contains the details of the update operation's result, including a confirmation message, the ID of the updated quote, and a success flag.
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Update an opportunityAGENCYZOOM_UPDATE_AN_OPPORTUNITYAcción

Updates an existing opportunity with the provided details; ensure any custom field names are predefined in agencyzoom configuration.

Parámetros de entrada

itemsinteger
Number of items (e.g., policies, vehicles) related to the opportunity.
premiuminteger
Premium amount.
carrierIdinteger
Insurance carrier identifier.
expiryDatestring
Policy or opportunity expiration date (MM/DD/YYYY).
customFieldsobject[]
List of custom fields to update. For date-types, use MM/DD/YYYY format.
productLineIdinteger
Product line identifier.
property__zipstring
Property's ZIP code.
property__citystring
Property's city name.
property__statestring
Property's state code (e.g., FL).
property__countrystring
Property's country code (e.g., USA).
property__address1string
Property's primary address line.
property__address2string
Property's secondary address line (e.g., apartment, suite).
property__useMailingAddressAsLocationinteger
Set to 1 to use lead's mailing address as property location, 0 otherwise. If 1, lead's address overwrites property address.

Parámetros de salida

dataobjectObligatorio
Contains details of the update operation's result.
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Update policy by idAGENCYZOOM_UPDATE_A_POLICYAcción

Updates an existing insurance policy for the given `policyid`; monetary values must be in cents and dates in yyyy-mm-dd format.

Parámetros de entrada

itemsintegerObligatorio
Number of items covered (e.g., vehicles for auto policy, properties for property policy).
agentIdintegerObligatorio
Unique identifier of the agent or producer who sold the policy.
premiumintegerObligatorio
Total premium amount for the policy term, in cents (e.g., $123.45 is 12345).
policyIdintegerObligatorio
Unique identifier of the policy to be updated (specified in the request path).
soldDatestringObligatorio
Date policy was sold or bound (Format: YYYY-MM-DD).
brokerFeeinteger
Broker fee for the policy, in cents (e.g., $50.00 is 5000).
carrierIdintegerObligatorio
Unique identifier of the insurance carrier.
groupCodestring
Code to associate the policy with a specific group for internal tracking or reporting.
expiryDatestringObligatorio
Date policy coverage ends (Format: YYYY-MM-DD).
policyTypeintegerObligatorio
Identifier for the type of policy transaction (e.g., New Business, Renewal).
insuredNamestring
Name(s) of the insured party or parties (individual or company).
agencyNumberstringObligatorio
Identifier for the agency branch or location associated with this policy.
leadSourceIdintegerObligatorio
Unique identifier for the lead source (e.g., referral, website).
policyNumberstring
Unique alphanumeric string assigned to the policy by the insurance carrier.
effectiveDatestringObligatorio
Date policy coverage begins (Format: YYYY-MM-DD).
departmentCodestring
Code to assign the policy to a specific department (e.g., Personal Lines, Commercial Lines).
priorExpiryDatestring
Expiry date of the previous policy (Format: YYYY-MM-DD), if applicable.
priorCarrierNamestring
Name of the previous insurance company, if applicable.
priorPolicyNumberstring
Policy number of the previous insurance policy, if applicable.
productCategoryIdintegerObligatorio
Identifier for the policy's product category (e.g., Auto, Home, Commercial).

Parámetros de salida

dataobjectObligatorio
Contains the policy update response: status message, updated policy ID, and success indicator.
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Update a vehicle's detailsAGENCYZOOM_UPDATE_A_VEHICLE_S_DETAILSAcción

Updates details for an existing vehicle within an opportunity; this action cannot be used to create new vehicle records.

Parámetros de entrada

vinstring
The Vehicle Identification Number (VIN) of the vehicle. Typically a 17-character string.
makestringObligatorio
The manufacturer of the vehicle.
yearinteger
The manufacturing year of the vehicle.
modelstring
The model of the vehicle.
ownershipstringenum
The ownership status of the vehicle. Defaults to 'Owned' if unspecified or if an empty string is provided.
FinancedLeasedOwned
vehicleIdintegerObligatorio
The unique identifier of the opportunity vehicle to be updated.

Parámetros de salida

dataobjectObligatorio
Contains the response data for the vehicle update operation.
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Update business leadAGENCYZOOM_UPDATE_BUSINESS_LEADAcción

Updates an existing business lead, identified by `leadid` (which must be valid and existing), using data provided in the request body not defined in this schema.

Parámetros de entrada

leadIdintegerObligatorio
Unique identifier (used in URL path) of the existing business lead to update.

Parámetros de salida

dataobjectObligatorio
Details of the update attempt: an optional message, ID of the updated lead, and success indicator.
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Update customer info using idAGENCYZOOM_UPDATE_CUSTOMERAcción

Updates an existing customer's information in agencyzoom using their unique customerid.

Parámetros de entrada

zipstring
Postal or ZIP code of the customer's address.
citystring
City of the customer's address.
csrIdinteger
The ID of the Customer Service Representative (CSR) assigned to the customer.
emailstring
Customer's primary email address.
phonestring
Customer's primary phone number.
statestring
State or province of the customer's address (e.g., CA, NY).
agentIdinteger
The ID of the producer or agent assigned to the customer.
countrystring
Country of the customer's address (e.g., USA, Canada).
birthdaystring
Customer's date of birth (MM/dd/YYYY format).
lastnamestring
Customer's last name.
tagNamesstring
Semicolon-separated string of tag names to associate with the customer (e.g., 'Lead;VIP;Past Client').
firstnamestring
Customer's first name.
createDatestring
Customer's creation date (MM/dd/YYYY format).
customerIdintegerObligatorio
Unique identifier for the customer to be updated. This value will also be used as the `customerId` in the API request path.
bizCustomerinteger
Indicates if the customer is a business. Use 1 for a business customer, 0 for an individual customer.
customFieldsobject[]
List of custom fields to update. Each item specifies `fieldName` and `fieldValue`. Date-type custom field values must be in 'MM/dd/YYYY' format.
totalPayrollinteger
Total payroll of the business. Applicable only if `bizCustomer` is 1 (commercial customer).
annualRevenueinteger
Annual revenue of the business. Applicable only if `bizCustomer` is 1 (commercial customer).
streetAddressstring
Customer's street address.
secondaryEmailstring
Customer's secondary email address.
secondaryPhonestring
Customer's secondary phone number.
contactLastnamestring
Last name of the primary contact, typically for business customers.
contactFirstnamestring
First name of the primary contact, typically for business customers.
contactMiddlenamestring
Middle name of the primary contact, typically for business customers.
numberOfEmployeesinteger
Number of employees. Applicable only if `bizCustomer` is 1 (commercial customer).

Parámetros de salida

dataobjectObligatorio
Contains the result of the update operation, including a status message, the customer ID, and a success indicator.
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Update leadAGENCYZOOM_UPDATE_LEADAcción

Updates an existing lead's information in agencyzoom using the `leadid`; ensure the `leadid` corresponds to an existing lead in agencyzoom.

Parámetros de entrada

zipstring
Postal or ZIP code of the lead's address.
citystring
City of the lead's address.
namestring
Name of the organization, if the lead is a business entity.
csrIdinteger
Identifier of the Customer Service Representative (CSR) assigned to the lead.
emailstringObligatorio
Lead's primary email address.
notesstring
Additional notes or comments related to the lead.
phonestring
Lead's primary phone number.
statestring
State or province of the lead's address.
xDatestring
Policy expiration date or key future date for lead's insurance needs (e.g., YYYY-MM-DD or MM/DD/YY), often policy renewal or X-date.
leadIdintegerObligatorio
The unique identifier of the lead to be updated.
countrystringObligatorio
Country of the lead's address.
stageIdintegerObligatorio
Identifier of the stage the lead is currently in within the pipeline.
assignTostringObligatorio
Identifier of the primary producer or agent to whom the lead is assigned.
birthdaystring
Lead's date of birth in MM/DD/YY format.
lastnamestring
Lead's last name.
nicknamestring
Lead's nickname.
soldDatestring
Date lead was marked as sold (e.g., YYYY-MM-DD).
tagNamesstring
A single string containing tag names, separated by semicolons (e.g., 'Hot Lead;Follow Up Q3').
firstnamestringObligatorio
Lead's first name.
groupCodestring
Group code associated with the lead.
otherCsrsinteger[]
List of unique identifiers for other Customer Service Representatives (CSRs) also assigned to the lead.
quoteDatestring
Date quote was provided to the lead (e.g., YYYY-MM-DD).
isBusinessboolean
Indicates if lead is a business entity (true) or an individual (false).
middlenamestring
Lead's middle name.
pipelineIdintegerObligatorio
Identifier of the sales pipeline the lead belongs to.
contactDatestring
Last contact date (e.g., YYYY-MM-DD).
agencyNumberstring
Agency's location code associated with the lead.
customFieldsobject[]
A list of custom fields and their values to update for the lead.
leadSourceIdintegerObligatorio
Identifier of the source from which the lead originated.
maritalStatusinteger
Integer code representing the lead's marital status (e.g., 1 for Single, 2 for Married). Consult AgencyZoom documentation for specific codes.
streetAddressstring
Lead's street address.
departmentCodestring
Department code associated with the lead.
otherProducersinteger[]
List of unique identifiers for other producers or agents also assigned to the lead.
secondaryEmailstring
Lead's secondary email address.
secondaryPhonestring
Lead's secondary phone number.
assignmentGroupIdinteger
Identifier of the assignment group for the lead.
nextExpirationDatestring
Next policy expiration date relevant to the lead, in MM/DD/YY format.
streetAddressLine2string
Additional line for the lead's street address.

Parámetros de salida

dataobjectObligatorio
Contains the response data from the API, including a confirmation message, the ID of the updated lead, and a success flag.
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Update lead status by idAGENCYZOOM_UPDATE_LEAD_STATUS_BY_IDAcción

Updates a lead's status (0=active, 2=won, 3=lost, 5=xdated) by `leadid`, optionally setting workflow, stage, date, loss reason, x-date type, source, recycle stage/pipeline, or tags; requires `date` and `xdatetype` for status 5 (xdated), and `lossreasonid` for status 3 (lost).

Parámetros de entrada

datestring
Optional. The relevant date associated with the status change. If status is XDATED (5), this is the reactivation date. Otherwise, it can be the contact or quoted date. Format: ISO 8601 string (e.g., YYYY-MM-DDTHH:mm:ssZ).
leadIdintegerObligatorio
The unique identifier for the lead whose status is to be updated.
statusintegerObligatorio
The new status for the lead. Allowed values are 0 (ACTIVE), 2 (WON), 3 (LOST), 5 (XDATED).
tagIdsinteger[]
Optional. A list of tag identifiers (integers) to be applied to or updated on the lead.
toStageIdinteger
Optional. The identifier of the target workflow stage to move the lead to. This can be used for general stage movements.
xDateTypestring
Optional. A descriptive name for the X-date recycle event (e.g., 'Renewal Reminder', 'Policy Expiration'). Used when `status` is 5 (XDATED) to specify the nature of the future follow-up.
workflowIdinteger
Optional. Identifier of the workflow to associate with the lead.
lossReasonIdinteger
Optional. The identifier for the reason a lead was lost, referencing an entry in the `leadLossReason` table. Typically used when `status` is 3 (LOST).
recycleToStageinteger
Optional. The identifier of the stage to which the lead should be moved if it's being recycled.
workflowStageIdinteger
Optional. Identifier of the specific stage within a workflow.
recycleToPipelineinteger
Optional. The identifier of the pipeline to which the lead should be moved if it's being recycled.
changeLeadSourceTointeger
Optional. The identifier for a new lead source, referencing an entry in the `leadSource` table. Use this to update the lead's origin.

Parámetros de salida

dataobjectObligatorio
Contains the detailed response of the lead status update, including a success flag, message, and the ID of the modified lead.
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Update my profileAGENCYZOOM_UPDATE_MY_PROFILEAcción

Updates the profile information (first name, last name, email, and optional phone) for the currently authenticated user in agencyzoom; the provided email address must be unique within the system.

Parámetros de entrada

emailstringObligatorio
The user's email address. This must be unique within the AgencyZoom system.
phonestring
The user's optional phone number.
lastnamestringObligatorio
The user's last name.
firstnamestringObligatorio
The user's first name.

Parámetros de salida

dataobjectObligatorio
Response data from the profile update, including an optional message, user ID (if available), and success indicator.
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Add tags to a policyAGENCYZOOM_UPDATE_TAGS_FOR_A_POLICYAcción

Adds new comma-separated `tagnames` to a policy, requiring `tagnames` and identification by either `policyid` or `amspolicyid`; if `amspolicyid` is provided, `policyid` is ignored, and existing tags are not affected.

Parámetros de entrada

policyIdinteger
The unique identifier of the policy within AgencyZoom. This field is ignored if `amsPolicyId` is provided.
tagNamesstring
A comma-separated string of tag names to add to the policy. For example, 'New Lead,Follow Up'.
amsPolicyIdinteger
The unique identifier of the policy as recognised by the Agency Management System (AMS). If provided, this ID is used to locate the policy.

Parámetros de salida

dataobjectObligatorio
Contains the detailed response data from the update tags operation.
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Update taskAGENCYZOOM_UPDATE_TASKAcción

Modifies an existing agencyzoom task (which must be valid and identified by `taskid` in the path) with new attributes from the request body, which must also contain `taskid`.

Parámetros de entrada

taskIdintegerObligatorio
The unique identifier of the task. This should match the `taskId` specified in the URL path.

Parámetros de salida

dataobjectObligatorio
Contains the detailed result of the task update operation, including any confirmation messages and the ID of the modified task.
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Log user in via SSOAGENCYZOOM_V4_SSO_LOG_THE_USER_INAcción

Logs a user into the agencyzoom platform via single sign-on (sso).

Parámetros de entrada

passwordstringObligatorio
User's password for SSO authentication.
usernamestringObligatorio
User's email address, serving as their username for the SSO login.

Parámetros de salida

dataobjectObligatorio
The core data returned upon successful SSO login, including the JWT and owner agent status.
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not