Skip to main content
AgencyZoom logo
  • Category: crm
  • Auth: API_KEY, BASIC_WITH_JWT
  • Composio-managed OAuth available? N/A
  • Tools: 99
  • Triggers: 0
  • Slug: AGENCYZOOM
  • Version: 20261101_00

Tools

Slug: AGENCYZOOM_AUTHENTICATE_FOR_JWTVIA_V4_SSOCompletes AgencyZoom V4 Single Sign-On (SSO) authentication by exchanging an OAuth2 authorization code for a JWT token. Prerequisites: First call get_auth_url_for_v4sso to obtain the authentication URL, then redirect the user to that URL for login. After successful authentication through Vertafore’s OAuth provider, the callback will include a ‘code’ parameter. Use that code with this action to obtain the JWT token for API access. Note: This is typically used during initial authentication setup. The code is single-use, time-limited, and must match the PKCE challenge from the original auth request.

Input Parameters

string
required
OAuth2 authorization code received from the V4SSO callback after user authentication through Vertafore login. This code is obtained by redirecting the user to the auth URL from GET /v1/api/v4sso/get-auth-params, where they authenticate, and the OAuth provider redirects back with this code parameter. The code is single-use and time-limited.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: AGENCYZOOM_BATCH_CREATE_CONTACTCreates 1 to 5 new contacts in AgencyZoom in a single batch API call.

Input Parameters

array
required
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.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: AGENCYZOOM_BATCH_CREATE_LEADCreates 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.

Input Parameters

array
List of lead data objects. A maximum of 5 leads can be created per request.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: AGENCYZOOM_BATCH_DELETE_TASKDeletes multiple AgencyZoom tasks in a batch; task deletion is permanent and the response indicates overall batch success, not individual task status.

Input Parameters

array
required
List of unique numerical identifiers for the tasks to be deleted. Must provide at least one task ID.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: AGENCYZOOM_CHANGE_STATUS_FOR_LEADUpdates a lead’s lifecycle status (e.g., Active, Won, Lost, X-Dated) and can optionally manage its workflow, pipeline, stage, source, or associated tags.

Input Parameters

string
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.
integer
required
Unique identifier of the lead to be updated (path parameter).
integer
required
New status for the lead: 0 (ACTIVE), 2 (WON), 3 (LOST), 5 (XDATED).
array
List of tag IDs to associate with the lead.
integer
ID of a specific workflow stage for direct assignment, irrespective of recycling.
string
Type or reason for the X-date, used if status is 5 (XDATED) (e.g., a predefined X-date recycle event name).
integer
Identifier of the workflow to associate; if provided, the lead moves to this workflow.
integer
Identifier for the loss reason. Recommended if status is 3 (LOST).
integer
ID of the stage to move the lead to if it is being recycled.
integer
Identifier of the stage within the specified workflow to move the lead to.
integer
ID of the pipeline to move the lead to if it is being recycled.
integer
Identifier for a new lead source to assign, updating the lead’s origin.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: AGENCYZOOM_COMPLETE_TASKMarks an existing and accessible task in AgencyZoom as ‘completed’; this action does not return the full updated task object.

Input Parameters

integer
required
Unique identifier of the task to be marked as completed.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: AGENCYZOOM_CREATE_A_CUSTOMER_NOTEAdds a new note to an existing customer’s profile using their ID; cannot be used to edit or retrieve existing notes.

Input Parameters

string
required
The textual content of the note to be added to the customer’s profile.
integer
required
The unique identifier of the customer to whom the note will be added.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: AGENCYZOOM_CREATE_A_DRIVER_FOR_AN_OPPORTUNITYCreates a new driver record associated with an existing AgencyZoom opportunity using its ID; requires firstName and lastName, with optional fields for additional driver details.

Input Parameters

string ("F" | "M" | "U" | "X")
Gender of the driver. Valid values are: “M” (Male), “F” (Female), “U” (Unknown), “X” (Non-Binary).
string
The date of birth of the driver. Must be in MM/DD/YYYY format.
string
required
The last name of the driver.
string
required
The first name of the driver.
string
The middle name of the driver.
string ("CH" | "IN" | "OT" | "PA" | "SP")
Relationship status of the driver. Valid values are: “IN” (Named Insured), “SP” (Spouse), “PA” (Parent), “CH” (Child), “OT” (Other).
string
The driver’s license number.
integer
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).
integer
required
The unique identifier of the opportunity to which the new driver will be associated.
string
The state where the driver is licensed, using its two-letter abbreviation (e.g., NY for New York).

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: AGENCYZOOM_CREATE_A_LEAD_NOTEAdds a new note to an existing lead in AgencyZoom, identified by leadId.

Input Parameters

string
required
Textual content of the note to be created for the lead.
integer
required
Unique identifier of the lead to associate the note with.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: AGENCYZOOM_CREATE_A_LEAD_OPPORTUNITYAdds 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.

Input Parameters

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

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: AGENCYZOOM_CREATE_A_LEAD_QUOTECreates 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.

Input Parameters

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

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: AGENCYZOOM_CREATE_AN_OPPORTUNITYCreates a new lead opportunity in AgencyZoom; this action cannot update existing opportunities.

Input Parameters

integer
The number of items related to this opportunity, such as number of policies or vehicles.
integer
The premium amount for the opportunity.
integer
Identifier for the insurance carrier associated with the opportunity.
string
The expiration date of the policy or opportunity, in MM/dd/YYYY format.
array
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.
integer
required
Identifier for the policy type (product line) of the opportunity.
string
The ZIP code for the property associated with the opportunity.
string
The city name for the property, e.g., Monticello.
string
The state code for the property, e.g., FL for Florida.
string
The country code for the property, e.g., USA.
integer
required
Identifier for the lead associated with this opportunity.
string
Primary street address line for the property.
string
Secondary street address line for the property (e.g., apartment, suite, unit number).
integer
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.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: AGENCYZOOM_CREATE_A_VEHICLE_FOR_AN_OPPORTUNITYAdds a new vehicle record to a specified opportunity; opportunityId must refer to a valid, existing opportunity.

Input Parameters

string
Vehicle Identification Number (VIN); typically 17 characters.
string
required
Manufacturer of the vehicle (e.g., Toyota, Ford).
integer
Manufacturing year of the vehicle (e.g., 2023).
string
Model of the vehicle (e.g., Camry, Civic).
string ("Financed" | "Leased" | "Owned")
Ownership status. Defaults to ‘Owned’ if not provided.
integer
required
Identifier of the opportunity to associate the vehicle with.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: AGENCYZOOM_CREATE_BIZ_LEADCreates or updates a business lead in AgencyZoom using detailed personal and company information, for B2B sales and marketing lead management.

Input Parameters

string
‘Doing Business As’ name if the business operates under a name different from its legal name.
string
The fax number for the business.
string
The postal code or ZIP code of the business address.
string
The city where the business is located.
string
Federal Employer Identification Number (FEIN) or Federal Tax ID for the business.
string
required
The legal name of the business or company (required for business leads).
integer
The unique identifier of the Customer Service Representative (CSR) assigned to the business lead.
string
required
The primary email address of the business or primary contact.
string
Additional notes or comments about the business lead.
string
The primary phone number of the business.
string
The state or province where the business is located (e.g., CA, TX, NY).
string
The X-date (e.g., policy expiration or renewal date) associated with the business lead, preferably in YYYY-MM-DD format.
string
required
The country where the business is located (e.g., US, CA).
string
The annual payroll amount for the business.
integer
required
The unique identifier of the stage within the specified pipeline where the business lead will be placed.
string
required
The unique identifier (ID) of the producer or agent to whom the business lead is assigned.
string
The last name of the primary contact person for the business lead.
string
The date when the business lead was marked as sold, preferably in YYYY-MM-DD format.
string
A single string containing multiple tag names, separated by semicolons (;). These tags help categorize or segment the business lead.
string
required
The first name of the primary contact person for the business lead.
string
The group code associated with the business lead, if applicable.
array
A list of unique identifiers for other Customer Service Representatives (CSRs) also assigned to or associated with this business lead.
string
The date when a quote was provided to the business lead, preferably in YYYY-MM-DD format.
string
The middle name of the primary contact person.
integer
required
The unique identifier of the sales pipeline to which the business lead will be added.
string
The date of the last contact with the business lead, preferably in YYYY-MM-DD format.
string
The agency location code associated with the business lead, if applicable.
array
A list of custom field objects, each specifying a field name and its value(s) for the business lead.
integer
required
The unique identifier of the lead source (e.g., ‘Website’, ‘Referral’, ‘Trade Show’).
string
The annual revenue of the business.
string
The primary street address of the business.
string
The department code associated with the business lead, if applicable.
array
A list of unique identifiers for other producers or agents also assigned to or associated with this business lead.
string
An alternative or secondary email address for the business or contact.
string
An alternative or secondary phone number for the business.
integer
The unique identifier of the assignment group responsible for the business lead.
integer
The total number of employees working for the business.
string
The next important expiration date related to the business lead (e.g., current policy expiration), in MM/DD/YY format.
string
Additional street address information (e.g., suite, floor, or building number).
string
The year when the business was established or started operations.
integer
The unique identifier of the business classification code. Use the search_business_classifications action to get available classifications.
integer
The number of years of management experience for the business owner or primary contact.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: AGENCYZOOM_CREATE_LEADCreates a new lead or updates an existing one in AgencyZoom; ensure pipelineId, stageId, leadSourceId, and assignTo reference valid, existing entities.

Input Parameters

string
The postal code or ZIP code of the lead’s address.
string
The city of the lead’s address.
string
The name of the organization or company, required if ‘isBusiness’ is True.
integer
The unique identifier of the Customer Service Representative (CSR) assigned to the lead.
string
required
The primary email address of the lead.
string
Additional notes or comments about the lead.
string
The primary phone number of the lead.
string
The state or province of the lead’s address (e.g., CA, TX, NY).
string
The X-date (e.g., policy expiration or renewal date) associated with the lead, preferably in YYYY-MM-DD format.
string
required
The country of the lead’s address (e.g., US, CA).
integer
required
The unique identifier of the stage within the specified pipeline where the lead will be placed.
string
required
The unique identifier (ID) of the producer or agent to whom the lead is assigned.
string
The lead’s date of birth, in MM/DD/YY format.
string
The last name of the lead.
string
An informal name or nickname for the lead.
string
The date when the lead was marked as sold, preferably in YYYY-MM-DD format.
string
A single string containing multiple tag names, separated by semicolons (;). These tags help categorize or segment the lead.
string
required
The first name of the lead.
string
The group code associated with the lead, if applicable.
array
A list of unique identifiers for other Customer Service Representatives (CSRs) also assigned to or associated with this lead.
string
The date when a quote was provided to the lead, preferably in YYYY-MM-DD format.
boolean
Indicates whether the lead is a business entity (True) or an individual consumer (False).
string
The middle name of the lead.
integer
required
The unique identifier of the sales pipeline to which the lead will be added.
string
The date of the last contact with the lead, preferably in YYYY-MM-DD format.
string
The agency location code associated with the lead, if applicable.
array
A list of custom field objects, each specifying a field name and its value(s) for the lead.
integer
required
The unique identifier of the lead source (e.g., ‘Website’, ‘Referral’).
integer
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.
string
The primary street address of the lead.
string
The department code associated with the lead, if applicable.
array
A list of unique identifiers for other producers or agents also assigned to or associated with this lead.
string
An alternative or secondary email address for the lead.
string
An alternative or secondary phone number for the lead.
integer
The unique identifier of the assignment group responsible for the lead.
string
The next important expiration date related to the lead (e.g., current policy expiration), in MM/DD/YY format.
string
Additional street address information (e.g., apartment, suite, or unit number).

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: AGENCYZOOM_CREATE_TASKCreates 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.

Input Parameters

string ("call" | "email" | "meeting" | "todo")
Task type (‘call’, ‘email’, ‘meeting’, ‘todo’); highly recommended.
string
Title or name of the task; highly recommended for identification.
integer
Unique ID of an existing lead to link to this task; must be an existing lead if provided.
string
Additional notes, comments, or description for the task.
integer
Expected task duration in minutes, typically for ‘call’ or ‘meeting’ types.
array
List of email addresses for invitees, typically for ‘meeting’ type tasks.
integer
Unique ID of the AgencyZoom user to assign the task; must be an existing user if provided.
integer
Unique ID of an existing customer to link to this task; must be an existing customer if provided.
string
Due date and time, preferably in ISO 8601 format (e.g., ‘YYYY-MM-DDTHH:MM:SSZ’).
string
Email of the customer/lead to associate with the task; used if customerId or leadId is not provided.
boolean
If True, the time in dueDatetime is specific; otherwise, task is due anytime on dueDatetime’s date.
integer
Unique ID of the Life & Health Professional for this task, for specific insurance workflows.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: AGENCYZOOM_DELETE_A_CUSTOMERIrreversibly deletes a customer and all associated data in AgencyZoom using their customerId; useful for offboarding or data privacy compliance.

Input Parameters

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

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: AGENCYZOOM_DELETE_A_CUSTOMER_FILEPermanently deletes a specific file, identified by fileId, associated with a customer, identified by customerId.

Input Parameters

integer
required
The unique identifier for the file to be deleted from the specified customer’s record.
integer
required
The unique identifier for the customer whose file is to be deleted.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: AGENCYZOOM_DELETE_A_CUSTOMER_POLICYPermanently deletes a specific policy associated with a customer, for instance, if it’s cancelled or inactive; this action is irreversible and requires caution.

Input Parameters

integer
required
The unique identifier of the policy to be deleted from the specified customer’s account.
integer
required
The unique identifier of the customer whose policy is to be deleted.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: AGENCYZOOM_DELETE_A_DRIVERPermanently deletes an existing driver record (a person associated with an insurance opportunity) from AgencyZoom using its unique driverId; this action is irreversible.

Input Parameters

integer
required
The unique identifier of the driver record to be deleted.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: AGENCYZOOM_DELETE_A_LEAD_FILEDeletes a specific file (identified by fileId) associated with an existing lead (identified by leadId); this operation is irreversible.

Input Parameters

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

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: AGENCYZOOM_DELETE_A_LEAD_OPPORTUNITYPermanently deletes an existing opportunity (by opportunityId) associated with an existing lead (by leadId) when it’s irrelevant, closed, or erroneous; the lead itself remains.

Input Parameters

integer
required
The unique identifier for the lead whose opportunity is to be deleted.
integer
required
The unique identifier for the opportunity to be deleted.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: AGENCYZOOM_DELETE_A_LEAD_QUOTEDeletes a specific quote from a lead, requiring that the lead and quote exist and are associated.

Input Parameters

integer
required
Unique identifier of the lead.
integer
required
Unique identifier of the quote to be deleted.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: AGENCYZOOM_DELETE_AN_OPPORTUNITYPermanently deletes a specific opportunity by its unique ID; this action is irreversible and requires a valid, existing opportunityId.

Input Parameters

integer
required
The unique identifier of the opportunity to be deleted.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: AGENCYZOOM_DELETE_A_TASKPermanently and irreversibly deletes an existing task, identified by its taskId.

Input Parameters

integer
required
Unique identifier of the task to delete.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: AGENCYZOOM_DELETE_A_VEHICLEPermanently deletes a vehicle record by its vehicleId, which must correspond to an existing vehicle in the AgencyZoom system.

Input Parameters

integer
required
Unique identifier of the vehicle to be deleted.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: AGENCYZOOM_DELETE_MESSAGEDeletes a specific message from an email thread within AgencyZoom. Requires the message ID to identify which message to remove. Returns the updated thread information with the remaining messages after deletion.

Input Parameters

integer
required
The unique identifier of the message to be deleted from the email thread. This ID can be obtained from thread details (messageInfo.id field) or search results.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: AGENCYZOOM_DELETE_THREADPermanently deletes a specific email thread from the AgencyZoom system, identified by its threadId (expected by the endpoint), provided the thread exists.

Input Parameters

string
required
Unique identifier of the email thread to be permanently deleted.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: AGENCYZOOM_GET_A_LIST_OF_ASSIGN_GROUPSRetrieves all assign groups configured in AgencyZoom, used for categorizing or assigning items to specific teams or units.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: AGENCYZOOM_GET_A_LIST_OF_CARRIERSRetrieves all insurance carriers from AgencyZoom, typically used for populating selection lists or synchronizing carrier data; does not return detailed policy or coverage information.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: AGENCYZOOM_GET_A_LIST_OF_CSRSFetches all Customer Service Representatives (CSRs), including their ID and name, returning an empty list if none are configured.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: AGENCYZOOM_GET_A_LIST_OF_CUSTOM_FIELDSRetrieves metadata for all configured custom field definitions, not the specific values entered for individual records.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: AGENCYZOOM_GET_A_LIST_OF_DRIVERS_FOR_AN_OPPORTUNITYRetrieves a list of drivers (individuals), including their personal details, licensing information, and relationship status, associated with a specific, existing opportunityId in AgencyZoom.

Input Parameters

integer
required
Unique identifier of the opportunity.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: AGENCYZOOM_GET_A_LIST_OF_EMPLOYEESRetrieves a complete list of all employees for the authenticated agency; returns an empty list if no employees are configured.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: AGENCYZOOM_GET_A_LIST_OF_LEAD_SOURCE_CATEGORIESRetrieves a comprehensive list of all predefined lead source categories from AgencyZoom, used to classify lead origins.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: AGENCYZOOM_GET_A_LIST_OF_LEAD_SOURCESFetches a list of all lead sources configured in AgencyZoom, including their ID, name, sales exclusion status, and category ID.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: AGENCYZOOM_GET_A_LIST_OF_LIFE_PROFESSIONALSRetrieves a list of life insurance professionals, including only their contact and status information (excluding sales or customer data), from the AgencyZoom platform.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: AGENCYZOOM_GET_A_LIST_OF_LOCATIONSRetrieves all agency locations or branches from AgencyZoom; filtering options are not available.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: AGENCYZOOM_GET_A_LIST_OF_LOSS_REASONSRetrieves all predefined loss reasons (e.g., ‘Lost to competitor’, ‘Premium too high’) available in AgencyZoom. These reasons can be used when marking leads as lost or for reporting purposes. No parameters required - returns complete list.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: AGENCYZOOM_GET_A_LIST_OF_PIPELINESRetrieves 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.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: AGENCYZOOM_GET_A_LIST_OF_PRODUCERRetrieves a list of all producers from AgencyZoom, typically related to text thread functionalities.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: AGENCYZOOM_GET_A_LIST_OF_PRODUCT_LINES_POLICY_TYPESFetches all product lines and policy types from AgencyZoom, each detailed with its ID, name, and product category ID.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: AGENCYZOOM_GET_A_LIST_OF_RECYCLE_EVENTSRetrieves the available recycle event types and any existing X-Date information for a specified lead in AgencyZoom. Returns a list of recycle event categories that can be used to trigger follow-ups (e.g., ‘X-Date’, ‘Accident Falls Off’, ‘Prior Insurance Fulfilled’).

Input Parameters

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

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: AGENCYZOOM_GET_A_LIST_OF_VEHICLES_FOR_AN_OPPORTUNITYRetrieves all vehicles associated with an existing opportunity, using its unique opportunityId.

Input Parameters

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

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: AGENCYZOOM_GET_AMS_POLICIES_FOR_A_CUSTOMERRetrieves 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.

Input Parameters

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

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: AGENCYZOOM_GET_AUTH_URL_FOR_V4_SSORetrieves 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.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: AGENCYZOOM_GET_DEPARTMENTS_GROUPSFetches department and group information for an agency, optionally filtered by a specific agencyNumber, to analyze its organizational structure.

Input Parameters

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

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: AGENCYZOOM_GET_LEAD_FILESRetrieves metadata (id, title, MIME type, size, dates, creator info) for files attached to leads in AgencyZoom. Optionally filter by leadId to get files for a specific lead, or omit to retrieve files across all leads. Returns file metadata only, not the actual file content.

Input Parameters

integer
Optional unique identifier of the lead to retrieve files for. If omitted, may return files across all leads.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: AGENCYZOOM_GET_LEAD_NOTESFetches 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.

Input Parameters

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

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: AGENCYZOOM_GET_LEAD_QUOTESRetrieves all insurance quotes (active and inactive) for a specific lead ID, useful for reviewing or tracking quote history.

Input Parameters

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

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: AGENCYZOOM_GET_LEAD_TASKSRetrieves all tasks for a specific lead, identified by its leadId, to review its activity history or manage follow-ups.

Input Parameters

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

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: AGENCYZOOM_GET_LIST_OF_END_STAGESFetches a list of all defined end stages, representing final steps in processes like lead conversion or policy closure.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: AGENCYZOOM_GET_POLICIES_FOR_A_CUSTOMERRetrieves from AgencyZoom all insurance policies for an existing customer (identified by customerId), including policy details like type, carrier, premium, effective dates, and assigned agents. Excludes premium payment history or claims information.

Input Parameters

integer
required
Unique identifier for the customer.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: AGENCYZOOM_GET_THE_CUSTOMER_DETAILSFetches comprehensive details for a specific customer, including personal information, policies, notes, tasks, files, and custom fields, using their unique customer ID.

Input Parameters

integer
required
Unique identifier of the customer to retrieve details for.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: AGENCYZOOM_GET_THE_CUSTOMER_TASKSFetches tasks for an AgencyZoom customer by customer ID. Use this read-only operation to review the customer’s activities, follow-ups, and action items.

Input Parameters

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

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: AGENCYZOOM_GET_THE_DRIVER_DETAILSRetrieves detailed information for a specific, existing driver (by driverId) associated with an AgencyZoom opportunity.

Input Parameters

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

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: AGENCYZOOM_GET_THE_LEAD_DETAILSRetrieves 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.

Input Parameters

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

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: AGENCYZOOM_GET_THE_OPPORTUNITIES_FOR_A_LEADRetrieves all sales opportunities and their details for a specified, existing leadId in AgencyZoom.

Input Parameters

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

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: AGENCYZOOM_GET_THE_OPPORTUNITY_DETAILSFetches comprehensive details for an existing opportunity using its unique opportunityId.

Input Parameters

integer
required
The unique identifier for the opportunity to retrieve.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: AGENCYZOOM_GET_THE_TASK_DETAILSRetrieves comprehensive details for a specific task using its unique taskId, which must correspond to an existing task in AgencyZoom.

Input Parameters

integer
required
Unique identifier of the task to retrieve.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: AGENCYZOOM_GET_THE_VEHICLE_DETAILSRetrieves detailed information for a specific vehicle, often associated with an AgencyZoom opportunity, using its unique vehicleId.

Input Parameters

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

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: AGENCYZOOM_GET_THREAD_DETAILSSearches and retrieves detailed information for email threads in AgencyZoom; no explicit search criteria are passed in this request.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: AGENCYZOOM_LIST_PRODUCT_CATEGORIESRetrieves a complete, unfiltered list of all product categories (ID and name) from AgencyZoom, useful for understanding product organization or populating UI elements.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: AGENCYZOOM_LOG_THE_USER_INAuthenticates 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.

Input Parameters

string
required
The user’s account password. Must match the password associated with the provided email/username.
string
required
The user’s email address used as the login username. Must be a valid email format for an existing AgencyZoom account.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: AGENCYZOOM_LOG_THE_USER_OUTUse this action to log the current user out of AgencyZoom by invalidating their active session token.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: AGENCYZOOM_MARK_THREAD_AS_UNREAD_API_ENDPOINTMarks 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.

Input Parameters

string
required
The unique identifier of the text/SMS thread whose read/unread status is to be updated. This must be a valid thread ID from the AgencyZoom system.
boolean
required
Boolean flag to control the thread’s read/unread status. Set to true to mark the thread as unread, or false to mark it as read.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: AGENCYZOOM_MOVE_LEAD_TO_SOLDMarks 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.

Input Parameters

integer
required
Identifier of the lead to be marked as sold.
boolean
If true, lead remains open after products are marked sold (e.g., for other potential sales). Defaults to false.
array
required
List of products sold to the lead.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: AGENCYZOOM_REMOVE_TEXT_THREAD_ENDPOINTCall this action to permanently delete an SMS/text message thread in AgencyZoom; the target thread is identified by its threadId. Note: This operation is idempotent - deleting a non-existent thread will return success.

Input Parameters

string
required
The unique identifier of the SMS/text message thread to be deleted. This can be obtained from the search_sms_threads action.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: AGENCYZOOM_REOPEN_A_TASKReopens an existing AgencyZoom task that is currently ‘completed’ or ‘closed’, allowing it to be reactivated with optional comments.

Input Parameters

integer
required
The unique identifier of the task to be reopened.
string
Optional comments providing context or reasons for reopening the task.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: AGENCYZOOM_SEARCH_BUSINESS_CLASSIFICATIONSRetrieves a comprehensive list of all available business classifications from AgencyZoom, each including an ID, code, and description.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: AGENCYZOOM_SEARCH_CUSTOMERSRetrieves customer results from AgencyZoom. The action exposes no search criteria, filtering, sorting, or pagination inputs.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: AGENCYZOOM_SEARCH_EMAIL_THREADSRetrieves 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.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: AGENCYZOOM_SEARCH_LEADSRetrieves lead results from AgencyZoom. The action exposes no filter, pagination, or sorting inputs.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: AGENCYZOOM_SEARCH_LEADS_COUNTRetrieves 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.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: AGENCYZOOM_SEARCH_LIFE_AND_HEALTH_LEADSSearches for life and health insurance leads in AgencyZoom, returning lead details and pagination information.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: AGENCYZOOM_SEARCH_SMS_THREADSSearches and retrieves SMS threads from AgencyZoom.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: AGENCYZOOM_SEARCH_TASKSSearches and lists tasks with pagination, sorting, and filter criteria.

Input Parameters

integer
Page number for pagination.
string
Field to sort by.
string
Filter by task type.
string
Sort order: ‘asc’ or ‘desc’.
string
Filter by time period (e.g., ‘today’, ‘week’, ‘month’).
integer
Filter by task status: 0 (Open), 1 (Done), 2 (Cancelled).
string
Filter tasks created/due on or before this date (YYYY-MM-DD).
string
Filter by location code or name.
integer
Number of tasks to return per page.
string
Filter tasks created/due on or after this date (YYYY-MM-DD).
integer
Filter by assignee user ID.
integer
Filter by lead source ID.
integer
Filter by life professional ID.
integer
Filter by lead source category ID.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: AGENCYZOOM_SERVICE_TICKET_LISTRetrieves a paginated list of service tickets from AgencyZoom. Supports filtering by: - Status (0=removed, 1=active, 2=completed) - Priority ID and Category ID Returns service ticket details including subject, description, dates, assignment information, and workflow stage. Results are paginated with default page size of 20 tickets per page.

Input Parameters

integer
The page number to retrieve (0-indexed). Defaults to 0 if not specified.
integer
Filter by service ticket status: 0 for ‘removed’, 1 for ‘active’, or 2 for ‘completed’. If not specified, returns all statuses.
integer
The number of service tickets to return per page. Defaults to 20 if not specified.
integer
Filter by service ticket category identifier. Use 0 to return all categories.
integer
Filter by service ticket priority identifier. Use 0 to return all priorities.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: AGENCYZOOM_TEXT_DETAIL_THREADRetrieves detailed messages for a specific SMS/text thread by its thread ID. Returns all messages in the thread with their content, attachments, sender/recipient information, and metadata. The thread ID can be obtained from the search_sms_threads action.

Input Parameters

string
The unique identifier of the SMS/text thread to retrieve details for. This ID can be obtained from the search_sms_threads action.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: AGENCYZOOM_UNREAD_THREADUpdates the read or unread status of a specific email thread within AgencyZoom.

Input Parameters

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

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: AGENCYZOOM_UPDATE_A_DRIVER_S_DETAILSUpdates an existing driver’s details in AgencyZoom, requiring driverId in the path and firstName and lastName in the request.

Input Parameters

string ("F" | "M" | "U" | "X")
Gender of the driver. Valid values are: “M” (Male), “F” (Female), “U” (Unknown), “X” (Non-Binary).
string
The date of birth of the driver. Must be in MM/DD/YYYY format.
integer
required
The unique identifier for the opportunity driver whose details are to be updated.
string
required
The last name of the driver.
string
required
The first name of the driver.
string
The middle name of the driver.
string ("CH" | "IN" | "OT" | "PA" | "SP")
Relationship status of the driver. Valid values are: “IN” (Named Insured), “SP” (Spouse), “PA” (Parent), “CH” (Child), “OT” (Other).
string
The driver’s license number.
integer
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).
string
The state where the driver is licensed, using its two-letter abbreviation (e.g., NY for New York).

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: AGENCYZOOM_UPDATE_A_LEAD_FILE_NAMEUpdates the name of a lead’s file using the lead ID, file ID, and new file name. An optional customer referral ID can also be supplied.

Input Parameters

integer
required
The unique identifier of the file to be renamed. This file must exist and be associated with the specified lead.
integer
required
The unique identifier of the lead whose file needs to be renamed.
string
required
The desired new name for the file. Should include the file extension (e.g., ‘.pdf’, ‘.docx’).
integer
The identifier of the customer referral associated with the lead file. This may be required depending on the file’s association in the AgencyZoom system.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: AGENCYZOOM_UPDATE_A_LEAD_OPPORTUNITYUpdates 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.

Input Parameters

integer
required
Unique identifier of the opportunity to update.
integer
Number of items associated with this opportunity (e.g., policies, vehicles).
integer
required
Unique identifier of the lead.
integer
required
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.
integer
required
Unique identifier of the insurance carrier.
array
A list of custom fields to update for the opportunity. For date-type custom fields, ensure the value is formatted as ‘MM/DD/YYYY’.
integer
required
Unique identifier of the product line.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: AGENCYZOOM_UPDATE_A_LEAD_QUOTEUpdates 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.

Input Parameters

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

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: AGENCYZOOM_UPDATE_AN_OPPORTUNITYUpdates an existing opportunity with the supplied details. If items is omitted, the request sends 1; custom field names should be predefined in AgencyZoom.

Input Parameters

integer
Number of items (e.g., policies, vehicles) related to the opportunity.
integer
Premium amount.
integer
Insurance carrier identifier.
string
Policy or opportunity expiration date (MM/DD/YYYY).
array
List of custom fields to update. For date-types, use MM/DD/YYYY format.
integer
required
The unique identifier for the opportunity to update.
integer
Product line identifier.
string
Property’s ZIP code.
string
Property’s city name.
string
Property’s state code (e.g., FL).
string
Property’s country code (e.g., USA).
string
Property’s primary address line.
string
Property’s secondary address line (e.g., apartment, suite).
integer
Set to 1 to use lead’s mailing address as property location, 0 otherwise. If 1, lead’s address overwrites property address.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: AGENCYZOOM_UPDATE_A_POLICYUpdates an existing insurance policy for the given policyId; monetary values must be in cents and dates in YYYY-MM-DD format.

Input Parameters

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

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: AGENCYZOOM_UPDATE_A_VEHICLE_S_DETAILSUpdates details for an existing vehicle within an opportunity; this action cannot be used to create new vehicle records.

Input Parameters

string
The Vehicle Identification Number (VIN) of the vehicle. Typically a 17-character string.
string
The manufacturer of the vehicle.
integer
The manufacturing year of the vehicle.
string
The model of the vehicle.
string ("Financed" | "Leased" | "Owned")
The ownership status of the vehicle. Defaults to ‘Owned’ if unspecified or if an empty string is provided.
integer
required
The unique identifier of the opportunity vehicle to be updated.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: AGENCYZOOM_UPDATE_BUSINESS_LEADUpdates an existing business lead in AgencyZoom. Requires leadId (path parameter) plus core business information fields: firstname, email, name (business name), pipelineId, stageId, leadSourceId, assignTo (producer ID), and country. All other fields are optional and will only update if provided.

Input Parameters

string
‘Doing Business As’ name if the business operates under a name different from its legal name.
string
The fax number for the business.
string
The postal code or ZIP code of the business address.
string
The city where the business is located.
string
Federal Employer Identification Number (FEIN) or Federal Tax ID for the business.
string
required
The legal name of the business or company.
integer
The unique identifier of the Customer Service Representative (CSR) assigned to the business lead.
string
required
The primary email address of the business or primary contact.
string
Additional notes or comments about the business lead.
string
The primary phone number of the business.
string
The state or province where the business is located (e.g., CA, TX, NY).
string
The X-date (e.g., policy expiration or renewal date) associated with the business lead, preferably in YYYY-MM-DD format.
integer
required
Unique identifier (used in URL path) of the existing business lead to update.
string
required
The country where the business is located (e.g., US, CA).
string
The annual payroll amount for the business.
integer
required
The unique identifier of the stage within the specified pipeline where the business lead will be placed.
string
required
The unique identifier (ID) of the producer or agent to whom the business lead is assigned.
string
The last name of the primary contact person for the business lead.
string
The date when the business lead was marked as sold, preferably in YYYY-MM-DD format.
string
A single string containing multiple tag names, separated by semicolons (;). These tags help categorize or segment the business lead.
string
required
The first name of the primary contact person for the business lead.
string
The group code associated with the business lead, if applicable.
array
A list of unique identifiers for other Customer Service Representatives (CSRs) also assigned to or associated with this business lead.
string
The date when a quote was provided to the business lead, preferably in YYYY-MM-DD format.
string
The middle name of the primary contact person.
integer
required
The unique identifier of the sales pipeline to which the business lead will be moved.
string
The date of the last contact with the business lead, preferably in YYYY-MM-DD format.
string
The agency location code associated with the business lead, if applicable.
array
A list of custom field objects, each specifying a field name and its value(s) for the business lead.
integer
required
The unique identifier of the lead source (e.g., ‘Website’, ‘Referral’, ‘Trade Show’).
string
The annual revenue of the business.
string
The primary street address of the business.
string
The department code associated with the business lead, if applicable.
array
A list of unique identifiers for other producers or agents also assigned to or associated with this business lead.
string
An alternative or secondary email address for the business or contact.
string
An alternative or secondary phone number for the business.
integer
The unique identifier of the assignment group responsible for the business lead.
integer
The total number of employees working for the business.
string
The next important expiration date related to the business lead (e.g., current policy expiration), in MM/DD/YY format.
string
Additional street address information (e.g., suite, floor, or building number).
string
The year when the business was established or started operations.
integer
The unique identifier of the business classification code. Use the search_business_classifications action to get available classifications.
integer
The number of years of management experience for the business owner or primary contact.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: AGENCYZOOM_UPDATE_CUSTOMERUpdates an existing customer’s information in AgencyZoom using their unique customerId.

Input Parameters

string
Postal or ZIP code of the customer’s address.
string
City of the customer’s address.
integer
The ID of the Customer Service Representative (CSR) assigned to the customer.
string
Customer’s primary email address.
string
Customer’s primary phone number.
string
State or province of the customer’s address (e.g., CA, NY).
integer
The ID of the producer or agent assigned to the customer.
string
Country of the customer’s address (e.g., USA, Canada).
string
Customer’s date of birth (MM/dd/YYYY format).
string
Customer’s last name.
string
Semicolon-separated string of tag names to associate with the customer (e.g., ‘Lead;VIP;Past Client’).
string
Customer’s first name.
string
Customer’s creation date (MM/dd/YYYY format).
integer
required
Unique identifier for the customer to be updated. This value will also be used as the customerId in the API request path.
integer
Indicates if the customer is a business. Use 1 for a business customer, 0 for an individual customer.
array
List of custom fields to update. Each item specifies fieldName and fieldValue. Date-type custom field values must be in ‘MM/dd/YYYY’ format.
integer
Total payroll of the business. Applicable only if bizCustomer is 1 (commercial customer).
integer
Annual revenue of the business. Applicable only if bizCustomer is 1 (commercial customer).
string
Customer’s street address.
string
Customer’s secondary email address.
string
Customer’s secondary phone number.
string
Last name of the primary contact, typically for business customers.
string
First name of the primary contact, typically for business customers.
string
Middle name of the primary contact, typically for business customers.
integer
Number of employees. Applicable only if bizCustomer is 1 (commercial customer).

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: AGENCYZOOM_UPDATE_LEADUpdates an existing lead’s information in AgencyZoom using the leadId; ensure the leadId corresponds to an existing lead in AgencyZoom.

Input Parameters

string
Postal or ZIP code of the lead’s address.
string
City of the lead’s address.
string
Name of the organization, if the lead is a business entity.
integer
Identifier of the Customer Service Representative (CSR) assigned to the lead.
string
required
Lead’s primary email address.
string
Additional notes or comments related to the lead.
string
Lead’s primary phone number.
string
State or province of the lead’s address.
string
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.
integer
required
The unique identifier of the lead to be updated.
string
required
Country of the lead’s address.
integer
required
Identifier of the stage the lead is currently in within the pipeline.
string
required
Identifier of the primary producer or agent to whom the lead is assigned.
string
Lead’s date of birth in MM/DD/YY format.
string
Lead’s last name.
string
Lead’s nickname.
string
Date lead was marked as sold (e.g., YYYY-MM-DD).
string
A single string containing tag names, separated by semicolons (e.g., ‘Hot Lead;Follow Up Q3’).
string
required
Lead’s first name.
string
Group code associated with the lead.
array
List of unique identifiers for other Customer Service Representatives (CSRs) also assigned to the lead.
string
Date quote was provided to the lead (e.g., YYYY-MM-DD).
boolean
Indicates if lead is a business entity (true) or an individual (false).
string
Lead’s middle name.
integer
required
Identifier of the sales pipeline the lead belongs to.
string
Last contact date (e.g., YYYY-MM-DD).
string
Agency’s location code associated with the lead.
array
A list of custom fields and their values to update for the lead.
integer
required
Identifier of the source from which the lead originated.
integer
Integer code representing the lead’s marital status (e.g., 1 for Single, 2 for Married). Consult AgencyZoom documentation for specific codes.
string
Lead’s street address.
string
Department code associated with the lead.
array
List of unique identifiers for other producers or agents also assigned to the lead.
string
Lead’s secondary email address.
string
Lead’s secondary phone number.
integer
Identifier of the assignment group for the lead.
string
Next policy expiration date relevant to the lead, in MM/DD/YY format.
string
Additional line for the lead’s street address.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: AGENCYZOOM_UPDATE_LEAD_STATUS_BY_IDUpdates 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).

Input Parameters

string
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).
integer
required
The unique identifier for the lead whose status is to be updated.
integer
required
The new status for the lead. Allowed values are 0 (ACTIVE), 2 (WON), 3 (LOST), 5 (XDATED).
array
Optional. A list of tag identifiers (integers) to be applied to or updated on the lead.
integer
Optional. The identifier of the target workflow stage to move the lead to. This can be used for general stage movements.
string
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.
integer
Optional. Identifier of the workflow to associate with the lead.
integer
Optional. The identifier for the reason a lead was lost, referencing an entry in the leadLossReason table. Typically used when status is 3 (LOST).
integer
Optional. The identifier of the stage to which the lead should be moved if it’s being recycled.
integer
Optional. Identifier of the specific stage within a workflow.
integer
Optional. The identifier of the pipeline to which the lead should be moved if it’s being recycled.
integer
Optional. The identifier for a new lead source, referencing an entry in the leadSource table. Use this to update the lead’s origin.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: AGENCYZOOM_UPDATE_MY_PROFILEUpdates 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.

Input Parameters

string
required
The user’s email address. This must be unique within the AgencyZoom system.
string
The user’s optional phone number.
string
required
The user’s last name.
string
required
The user’s first name.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: AGENCYZOOM_UPDATE_TAGS_FOR_A_POLICYAdds 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.

Input Parameters

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

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: AGENCYZOOM_UPDATE_TASKUpdates an existing AgencyZoom task identified by taskId with the supplied task attributes.

Input Parameters

string ("call" | "email" | "meeting" | "todo")
Task type (‘call’, ‘email’, ‘meeting’, ‘todo’); highly recommended.
string
Title or name of the task; highly recommended for identification.
integer
Unique ID of an existing lead to link to this task; must be an existing lead if provided.
integer
required
The unique identifier of the task to update. This is specified in the URL path parameter.
string
Additional notes, comments, or description for the task.
integer
Expected task duration in minutes, typically for ‘call’ or ‘meeting’ types.
array
List of email addresses for invitees, typically for ‘meeting’ type tasks.
integer
Unique ID of the AgencyZoom user to assign the task; must be an existing user if provided.
integer
Unique ID of an existing customer to link to this task; must be an existing customer if provided.
string
Due date and time, preferably in ISO 8601 format (e.g., ‘YYYY-MM-DDTHH:MM:SSZ’).
string
Email of the customer/lead to associate with the task; used if customerId or leadId is not provided.
boolean
If True, the time in dueDatetime is specific; otherwise, task is due anytime on dueDatetime’s date.
integer
Unique ID of the Life & Health Professional for this task, for specific insurance workflows.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: AGENCYZOOM_V4_SSO_LOG_THE_USER_INLogs a user into the AgencyZoom platform via Single Sign-On (SSO). Returns JWT on success or error details on authentication failure.

Input Parameters

string
required
User’s password for SSO authentication.
string
required
User’s email address, serving as their username for the SSO login.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not