# AgencyZoom

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

- **Category:** crm
- **Auth:** API_KEY, BASIC_WITH_JWT
- **Composio Managed App Available?** N/A
- **Tools:** 99
- **Triggers:** 0
- **Slug:** `AGENCYZOOM`
- **Version:** 20260211_00

## Tools

### Authenticate for JWT via V4 SSO

**Slug:** `AGENCYZOOM_AUTHENTICATE_FOR_JWTVIA_V4_SSO`

Completes 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

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `code` | string | Yes | 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

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Batch create contacts

**Slug:** `AGENCYZOOM_BATCH_CREATE_CONTACT`

Creates 1 to 5 new contacts in AgencyZoom in a single batch API call.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `contactDataRequests` | array | Yes | 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

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Batch create leads

**Slug:** `AGENCYZOOM_BATCH_CREATE_LEAD`

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.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `leadDataRequests` | array | No | List of lead data objects. A maximum of 5 leads can be created per request. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Batch delete tasks

**Slug:** `AGENCYZOOM_BATCH_DELETE_TASK`

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

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `taskIds` | array | Yes | List of unique numerical identifiers for the tasks to be deleted. Must provide at least one task ID. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Change lead status

**Slug:** `AGENCYZOOM_CHANGE_STATUS_FOR_LEAD`

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.

#### Input Parameters

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

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Mark task as completed

**Slug:** `AGENCYZOOM_COMPLETE_TASK`

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

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `taskId` | integer | Yes | Unique identifier of the task to be marked as completed. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Create a customer note

**Slug:** `AGENCYZOOM_CREATE_A_CUSTOMER_NOTE`

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

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `note` | string | Yes | The textual content of the note to be added to the customer's profile. |
| `customerId` | integer | Yes | The unique identifier of the customer to whom the note will be added. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Create a driver for an opportunity

**Slug:** `AGENCYZOOM_CREATE_A_DRIVER_FOR_AN_OPPORTUNITY`

Creates 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

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `gender` | string ("F" | "M" | "U" | "X") | No | Gender of the driver. Valid values are: "M" (Male),  "F" (Female), "U" (Unknown), "X" (Non-Binary). |
| `birthday` | string | No | The date of birth of the driver. Must be in MM/DD/YYYY format. |
| `lastName` | string | Yes | The last name of the driver. |
| `firstName` | string | Yes | The first name of the driver. |
| `middleName` | string | No | The middle name of the driver. |
| `relationship` | string ("CH" | "IN" | "OT" | "PA" | "SP") | No | Relationship status of the driver. Valid values are: "IN" (Named Insured), "SP" (Spouse), "PA" (Parent), "CH" (Child), "OT" (Other). |
| `licenseNumber` | string | No | The driver's license number. |
| `maritalStatus` | integer | No | 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). |
| `opportunityId` | integer | Yes | The unique identifier of the opportunity to which the new driver will be associated. |
| `stateLicensed` | string | No | The state where the driver is licensed, using its two-letter abbreviation (e.g., NY for New York). |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Create a lead note

**Slug:** `AGENCYZOOM_CREATE_A_LEAD_NOTE`

Adds a new note to an existing lead in AgencyZoom, identified by `leadId`.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `note` | string | Yes | Textual content of the note to be created for the lead. |
| `leadId` | integer | Yes | Unique identifier of the lead to associate the note with. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Create a lead opportunity

**Slug:** `AGENCYZOOM_CREATE_A_LEAD_OPPORTUNITY`

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.

#### Input Parameters

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

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Create a lead quote

**Slug:** `AGENCYZOOM_CREATE_A_LEAD_QUOTE`

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.

#### Input Parameters

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

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Create an opportunity

**Slug:** `AGENCYZOOM_CREATE_AN_OPPORTUNITY`

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

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `items` | integer | No | The number of items related to this opportunity, such as number of policies or vehicles. |
| `premium` | integer | No | The premium amount for the opportunity. |
| `carrierId` | integer | No | Identifier for the insurance carrier associated with the opportunity. |
| `expiryDate` | string | No | The expiration date of the policy or opportunity, in MM/dd/YYYY format. |
| `customFields` | array | No | 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. |
| `productLineId` | integer | Yes | Identifier for the policy type (product line) of the opportunity. |
| `property__zip` | string | No | The ZIP code for the property associated with the opportunity. |
| `property__city` | string | No | The city name for the property, e.g., Monticello. |
| `property__state` | string | No | The state code for the property, e.g., FL for Florida. |
| `property__country` | string | No | The country code for the property, e.g., USA. |
| `customerReferralId` | integer | Yes | Identifier for the lead associated with this opportunity. |
| `property__address1` | string | No | Primary street address line for the property. |
| `property__address2` | string | No | Secondary street address line for the property (e.g., apartment, suite, unit number). |
| `property__useMailingAddressAsLocation` | integer | No | 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

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Create a vehicle for an opportunity

**Slug:** `AGENCYZOOM_CREATE_A_VEHICLE_FOR_AN_OPPORTUNITY`

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

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `vin` | string | No | Vehicle Identification Number (VIN); typically 17 characters. |
| `make` | string | Yes | Manufacturer of the vehicle (e.g., Toyota, Ford). |
| `year` | integer | No | Manufacturing year of the vehicle (e.g., 2023). |
| `model` | string | No | Model of the vehicle (e.g., Camry, Civic). |
| `ownership` | string ("Financed" | "Leased" | "Owned") | No | Ownership status. Defaults to 'Owned' if not provided. |
| `opportunityId` | integer | Yes | Identifier of the opportunity to associate the vehicle with. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Create business lead

**Slug:** `AGENCYZOOM_CREATE_BIZ_LEAD`

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

#### Input Parameters

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

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Create lead

**Slug:** `AGENCYZOOM_CREATE_LEAD`

Creates a new lead or updates an existing one in AgencyZoom; ensure `pipelineId`, `stageId`, `leadSourceId`, and `assignTo` reference valid, existing entities.

#### Input Parameters

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

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Create task post endpoint

**Slug:** `AGENCYZOOM_CREATE_TASK`

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.

#### Input Parameters

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

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Delete a customer

**Slug:** `AGENCYZOOM_DELETE_A_CUSTOMER`

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

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `customerId` | integer | Yes | The unique numerical identifier of the customer record to be permanently deleted. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Delete customer file

**Slug:** `AGENCYZOOM_DELETE_A_CUSTOMER_FILE`

Permanently deletes a specific file, identified by `fileId`, associated with a customer, identified by `customerId`.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `fileId` | integer | Yes | The unique identifier for the file to be deleted from the specified customer's record. |
| `customerId` | integer | Yes | The unique identifier for the customer whose file is to be deleted. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Delete a customer policy

**Slug:** `AGENCYZOOM_DELETE_A_CUSTOMER_POLICY`

Permanently 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

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `policyId` | integer | Yes | The unique identifier of the policy to be deleted from the specified customer's account. |
| `customerId` | integer | Yes | The unique identifier of the customer whose policy is to be deleted. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Delete an opportunity driver by ID

**Slug:** `AGENCYZOOM_DELETE_A_DRIVER`

Permanently deletes an existing driver record (a person associated with an insurance opportunity) from AgencyZoom using its unique `driverId`; this action is irreversible.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `driverId` | integer | Yes | The unique identifier of the driver record to be deleted. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Delete file from lead

**Slug:** `AGENCYZOOM_DELETE_A_LEAD_FILE`

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

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `fileId` | integer | Yes | The unique identifier for the file that needs to be deleted from the specified lead. |
| `leadId` | integer | Yes | The unique identifier for the lead whose file is to be deleted. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Delete a lead opportunity

**Slug:** `AGENCYZOOM_DELETE_A_LEAD_OPPORTUNITY`

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.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `leadId` | integer | Yes | The unique identifier for the lead whose opportunity is to be deleted. |
| `opportunityId` | integer | Yes | The unique identifier for the opportunity to be deleted. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Delete a lead quote

**Slug:** `AGENCYZOOM_DELETE_A_LEAD_QUOTE`

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

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `leadId` | integer | Yes | Unique identifier of the lead. |
| `quoteId` | integer | Yes | Unique identifier of the quote to be deleted. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Delete an opportunity

**Slug:** `AGENCYZOOM_DELETE_AN_OPPORTUNITY`

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

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `opportunityId` | integer | Yes | The unique identifier of the opportunity to be deleted. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Delete a task

**Slug:** `AGENCYZOOM_DELETE_A_TASK`

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

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `taskId` | integer | Yes | Unique identifier of the task to delete. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Delete a vehicle

**Slug:** `AGENCYZOOM_DELETE_A_VEHICLE`

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

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `vehicleId` | integer | Yes | Unique identifier of the vehicle to be deleted. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Delete thread message

**Slug:** `AGENCYZOOM_DELETE_MESSAGE`

Deletes 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

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `id` | integer | Yes | 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

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Delete email thread

**Slug:** `AGENCYZOOM_DELETE_THREAD`

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

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `threadId` | string | Yes | Unique identifier of the email thread to be permanently deleted. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get a list of assign groups

**Slug:** `AGENCYZOOM_GET_A_LIST_OF_ASSIGN_GROUPS`

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

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get a list of carriers

**Slug:** `AGENCYZOOM_GET_A_LIST_OF_CARRIERS`

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

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get a list of CSRs

**Slug:** `AGENCYZOOM_GET_A_LIST_OF_CSRS`

Fetches all Customer Service Representatives (CSRs), including their ID and name, returning an empty list if none are configured.

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get a list of custom fields

**Slug:** `AGENCYZOOM_GET_A_LIST_OF_CUSTOM_FIELDS`

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

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get a list of drivers for an opportunity

**Slug:** `AGENCYZOOM_GET_A_LIST_OF_DRIVERS_FOR_AN_OPPORTUNITY`

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

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `opportunityId` | integer | Yes | Unique identifier of the opportunity. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get a list of employees

**Slug:** `AGENCYZOOM_GET_A_LIST_OF_EMPLOYEES`

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

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get lead source categories

**Slug:** `AGENCYZOOM_GET_A_LIST_OF_LEAD_SOURCE_CATEGORIES`

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

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get lead sources

**Slug:** `AGENCYZOOM_GET_A_LIST_OF_LEAD_SOURCES`

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

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get a list of life professionals

**Slug:** `AGENCYZOOM_GET_A_LIST_OF_LIFE_PROFESSIONALS`

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

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get a list of locations

**Slug:** `AGENCYZOOM_GET_A_LIST_OF_LOCATIONS`

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

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get loss reasons

**Slug:** `AGENCYZOOM_GET_A_LIST_OF_LOSS_REASONS`

Retrieves 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

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get a list of pipelines

**Slug:** `AGENCYZOOM_GET_A_LIST_OF_PIPELINES`

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.

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get a list of producers

**Slug:** `AGENCYZOOM_GET_A_LIST_OF_PRODUCER`

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

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get product lines and policy types

**Slug:** `AGENCYZOOM_GET_A_LIST_OF_PRODUCT_LINES_POLICY_TYPES`

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

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get a list of recycle events

**Slug:** `AGENCYZOOM_GET_A_LIST_OF_RECYCLE_EVENTS`

Retrieves 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

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `leadId` | integer | Yes | The unique identifier of the lead for which to retrieve recycle events. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Retrieve vehicles for opportunity

**Slug:** `AGENCYZOOM_GET_A_LIST_OF_VEHICLES_FOR_AN_OPPORTUNITY`

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

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `opportunityId` | integer | Yes | Unique identifier for the opportunity, used to retrieve its associated vehicles. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get AMS policies for a customer

**Slug:** `AGENCYZOOM_GET_AMS_POLICIES_FOR_A_CUSTOMER`

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.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `customerId` | integer | Yes | Unique identifier for the customer whose AMS policy data is to be retrieved. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get auth URL for V4 SSO

**Slug:** `AGENCYZOOM_GET_AUTH_URL_FOR_V4_SSO`

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.

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get departments groups

**Slug:** `AGENCYZOOM_GET_DEPARTMENTS_GROUPS`

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

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `agencyNumber` | string | No | The unique identifier for the agency. If provided, fetches departments and groups for this specific agency. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get lead files

**Slug:** `AGENCYZOOM_GET_LEAD_FILES`

Retrieves 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

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `leadId` | integer | No | Optional unique identifier of the lead to retrieve files for. If omitted, may return files across all leads. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Retrieve notes for specific lead

**Slug:** `AGENCYZOOM_GET_LEAD_NOTES`

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.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `leadId` | integer | Yes | The unique identifier of the lead for whom notes are to be retrieved. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get lead quotes

**Slug:** `AGENCYZOOM_GET_LEAD_QUOTES`

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

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `leadId` | integer | Yes | The unique identifier for the lead whose quotes are to be retrieved. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get lead tasks

**Slug:** `AGENCYZOOM_GET_LEAD_TASKS`

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

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `leadId` | integer | Yes | The unique identifier for the lead whose tasks are to be retrieved. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get list of end stages

**Slug:** `AGENCYZOOM_GET_LIST_OF_END_STAGES`

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

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get policies for a customer

**Slug:** `AGENCYZOOM_GET_POLICIES_FOR_A_CUSTOMER`

Retrieves 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

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `customerId` | integer | Yes | Unique identifier for the customer. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get the customer details

**Slug:** `AGENCYZOOM_GET_THE_CUSTOMER_DETAILS`

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

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `customerId` | integer | Yes | Unique identifier of the customer to retrieve details for. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get the customer tasks

**Slug:** `AGENCYZOOM_GET_THE_CUSTOMER_TASKS`

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.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `customerId` | integer | Yes | Unique identifier for the customer whose tasks are to be retrieved. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get the driver details

**Slug:** `AGENCYZOOM_GET_THE_DRIVER_DETAILS`

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

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `driverId` | integer | Yes | The unique identifier of the driver whose details are to be retrieved. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get the lead details

**Slug:** `AGENCYZOOM_GET_THE_LEAD_DETAILS`

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.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `leadId` | integer | Yes | Unique identifier for the lead whose details are to be retrieved. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get the opportunities for a lead

**Slug:** `AGENCYZOOM_GET_THE_OPPORTUNITIES_FOR_A_LEAD`

Retrieves all sales opportunities and their details for a specified, existing `leadId` in AgencyZoom.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `leadId` | integer | Yes | The unique identifier of the lead for which opportunities are to be fetched. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get the opportunity details

**Slug:** `AGENCYZOOM_GET_THE_OPPORTUNITY_DETAILS`

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

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `opportunityId` | integer | Yes | The unique identifier for the opportunity to retrieve. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get the task details

**Slug:** `AGENCYZOOM_GET_THE_TASK_DETAILS`

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

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `taskId` | integer | Yes | Unique identifier of the task to retrieve. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get the vehicle details

**Slug:** `AGENCYZOOM_GET_THE_VEHICLE_DETAILS`

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

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `vehicleId` | integer | Yes | Unique identifier for the vehicle, often linked to an opportunity within AgencyZoom. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get thread details

**Slug:** `AGENCYZOOM_GET_THREAD_DETAILS`

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

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Link a driver to opportunity

**Slug:** `AGENCYZOOM_LINK_A_DRIVER_TO_OPPORTUNITY`

Assigns or reassigns an existing driver to an existing opportunity.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `driverId` | integer | Yes | The unique identifier for the existing driver (e.g., sales agent, team member) who will be linked to the opportunity. |
| `opportunityId` | integer | Yes | The unique identifier for the existing opportunity to which the driver will be linked. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Link vehicle to opportunity

**Slug:** `AGENCYZOOM_LINK_A_VEHICLE_TO_OPPORTUNITY`

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

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `vehicleId` | integer | Yes | Identifier of the vehicle to be linked to the opportunity. |
| `opportunityId` | integer | Yes | Identifier of the opportunity to which the vehicle will be linked. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### List Product Categories

**Slug:** `AGENCYZOOM_LIST_PRODUCT_CATEGORIES`

Retrieves a complete, unfiltered list of all product categories (ID and name) from AgencyZoom, useful for understanding product organization or populating UI elements.

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Log the user in

**Slug:** `AGENCYZOOM_LOG_THE_USER_IN`

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.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `password` | string | Yes | The user's account password. Must match the password associated with the provided email/username. |
| `username` | string | Yes | The user's email address used as the login username. Must be a valid email format for an existing AgencyZoom account. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Log the user out

**Slug:** `AGENCYZOOM_LOG_THE_USER_OUT`

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

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Mark thread as unread

**Slug:** `AGENCYZOOM_MARK_THREAD_AS_UNREAD_API_ENDPOINT`

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.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `threadId` | string | Yes | 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. |
| `markUnread` | boolean | Yes | 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

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Move lead to sold

**Slug:** `AGENCYZOOM_MOVE_LEAD_TO_SOLD`

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.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `leadId` | integer | Yes | Identifier of the lead to be marked as sold. |
| `keepOpen` | boolean | No | If true, lead remains open after products are marked sold (e.g., for other potential sales). Defaults to false. |
| `soldProducts` | array | Yes | List of products sold to the lead. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Remove text thread

**Slug:** `AGENCYZOOM_REMOVE_TEXT_THREAD_ENDPOINT`

Call 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

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `threadId` | string | Yes | The unique identifier of the SMS/text message thread to be deleted. This can be obtained from the search_sms_threads action. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Reopen a task

**Slug:** `AGENCYZOOM_REOPEN_A_TASK`

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

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `taskId` | integer | Yes | The unique identifier of the task to be reopened. |
| `comments` | string | No | Optional comments providing context or reasons for reopening the task. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Search business classifications

**Slug:** `AGENCYZOOM_SEARCH_BUSINESS_CLASSIFICATIONS`

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

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Search customers

**Slug:** `AGENCYZOOM_SEARCH_CUSTOMERS`

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

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Search email threads

**Slug:** `AGENCYZOOM_SEARCH_EMAIL_THREADS`

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.

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Search leads

**Slug:** `AGENCYZOOM_SEARCH_LEADS`

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

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Search leads count

**Slug:** `AGENCYZOOM_SEARCH_LEADS_COUNT`

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.

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Search life and health leads

**Slug:** `AGENCYZOOM_SEARCH_LIFE_AND_HEALTH_LEADS`

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.

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Search SMS threads

**Slug:** `AGENCYZOOM_SEARCH_SMS_THREADS`

Searches and retrieves SMS threads from AgencyZoom, with search parameters, filters, sorting, and pagination typically provided in the request body of this POST operation.

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Search and list tasks

**Slug:** `AGENCYZOOM_SEARCH_TASKS`

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

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `page` | integer | No | Page number for pagination. |
| `sort` | string | No | Field to sort by. |
| `type` | string | No | Filter by task type. |
| `order` | string | No | Sort order: 'asc' or 'desc'. |
| `period` | string | No | Filter by time period (e.g., 'today', 'week', 'month'). |
| `status` | integer | No | Filter by task status: 0 (Open), 1 (Done), 2 (Cancelled). |
| `endDate` | string | No | Filter tasks created/due on or before this date (YYYY-MM-DD). |
| `location` | string | No | Filter by location code or name. |
| `pageSize` | integer | No | Number of tasks to return per page. |
| `startDate` | string | No | Filter tasks created/due on or after this date (YYYY-MM-DD). |
| `assigneeId` | integer | No | Filter by assignee user ID. |
| `leadSourceId` | integer | No | Filter by lead source ID. |
| `lifeProfessionalId` | integer | No | Filter by life professional ID. |
| `leadSourceCategoryId` | integer | No | Filter by lead source category ID. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### List service tickets

**Slug:** `AGENCYZOOM_SERVICE_TICKET_LIST`

Retrieves 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

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `page` | integer | No | The page number to retrieve (0-indexed). Defaults to 0 if not specified. |
| `status` | integer | No | Filter by service ticket status: 0 for 'removed', 1 for 'active', or 2 for 'completed'. If not specified, returns all statuses. |
| `pageSize` | integer | No | The number of service tickets to return per page. Defaults to 20 if not specified. |
| `categoryId` | integer | No | Filter by service ticket category identifier. Use 0 to return all categories. |
| `priorityId` | integer | No | Filter by service ticket priority identifier. Use 0 to return all priorities. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get SMS thread messages

**Slug:** `AGENCYZOOM_TEXT_DETAIL_THREAD`

Retrieves 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

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `threadId` | string | No | The unique identifier of the SMS/text thread to retrieve details for. This ID can be obtained from the search_sms_threads action. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Unlink driver from opportunity

**Slug:** `AGENCYZOOM_UNLINK_A_DRIVER_FROM_OPPORTUNITY`

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.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `driverId` | integer | Yes | Identifier for the driver to be unlinked from the opportunity. |
| `opportunityId` | integer | Yes | Identifier for the opportunity from which the driver will be unlinked. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Unlink vehicle from opportunity

**Slug:** `AGENCYZOOM_UNLINK_A_VEHICLE_FROM_OPPORTUNITY`

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

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `vehicleId` | integer | Yes | The unique identifier of the vehicle to be unlinked from the specified opportunity. |
| `opportunityId` | integer | Yes | The unique identifier of the opportunity from which the vehicle will be unlinked. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Update email thread read status

**Slug:** `AGENCYZOOM_UNREAD_THREAD`

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

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `threadId` | string | Yes | The unique identifier of the email thread whose read status is to be updated. |
| `markUnread` | boolean | Yes | Set to true to mark the thread as unread, or false to mark it as read. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Update a driver's details

**Slug:** `AGENCYZOOM_UPDATE_A_DRIVER_S_DETAILS`

Updates an existing driver's details in AgencyZoom, requiring `driverId` in the path and `firstName` and `lastName` in the request.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `gender` | string ("F" | "M" | "U" | "X") | No | Gender of the driver. Valid values are: "M" (Male),  "F" (Female), "U" (Unknown), "X" (Non-Binary). |
| `birthday` | string | No | The date of birth of the driver. Must be in MM/DD/YYYY format. |
| `driverId` | integer | Yes | The unique identifier for the opportunity driver whose details are to be updated. |
| `lastName` | string | Yes | The last name of the driver. |
| `firstName` | string | Yes | The first name of the driver. |
| `middleName` | string | No | The middle name of the driver. |
| `relationship` | string ("CH" | "IN" | "OT" | "PA" | "SP") | No | Relationship status of the driver. Valid values are: "IN" (Named Insured), "SP" (Spouse), "PA" (Parent), "CH" (Child), "OT" (Other). |
| `licenseNumber` | string | No | The driver's license number. |
| `maritalStatus` | integer | No | 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). |
| `stateLicensed` | string | No | The state where the driver is licensed, using its two-letter abbreviation (e.g., NY for New York). |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Rename lead file

**Slug:** `AGENCYZOOM_UPDATE_A_LEAD_FILE_NAME`

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`.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `fileId` | integer | Yes | The unique identifier of the file to be renamed. This file must exist and be associated with the specified lead. |
| `leadId` | integer | Yes | The unique identifier of the lead whose file needs to be renamed. |
| `newFileName` | string | Yes | The desired new name for the file. Should include the file extension (e.g., '.pdf', '.docx'). |
| `customerReferralId` | integer | No | 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

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Update a lead opportunity

**Slug:** `AGENCYZOOM_UPDATE_A_LEAD_OPPORTUNITY`

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.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `id` | integer | Yes | Unique identifier of the opportunity to update. |
| `items` | integer | No | Number of items associated with this opportunity (e.g., policies, vehicles). |
| `leadId` | integer | Yes | Unique identifier of the lead. |
| `premium` | integer | Yes | 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. |
| `carrierId` | integer | Yes | Unique identifier of the insurance carrier. |
| `customFields` | array | No | A list of custom fields to update for the opportunity. For date-type custom fields, ensure the value is formatted as 'MM/DD/YYYY'. |
| `productLineId` | integer | Yes | Unique identifier of the product line. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Update lead quote data

**Slug:** `AGENCYZOOM_UPDATE_A_LEAD_QUOTE`

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.

#### Input Parameters

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

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Update an opportunity

**Slug:** `AGENCYZOOM_UPDATE_AN_OPPORTUNITY`

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

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `items` | integer | No | Number of items (e.g., policies, vehicles) related to the opportunity. |
| `premium` | integer | No | Premium amount. |
| `carrierId` | integer | No | Insurance carrier identifier. |
| `expiryDate` | string | No | Policy or opportunity expiration date (MM/DD/YYYY). |
| `customFields` | array | No | List of custom fields to update. For date-types, use MM/DD/YYYY format. |
| `opportunityId` | integer | Yes | The unique identifier for the opportunity to update. |
| `productLineId` | integer | No | Product line identifier. |
| `property__zip` | string | No | Property's ZIP code. |
| `property__city` | string | No | Property's city name. |
| `property__state` | string | No | Property's state code (e.g., FL). |
| `property__country` | string | No | Property's country code (e.g., USA). |
| `property__address1` | string | No | Property's primary address line. |
| `property__address2` | string | No | Property's secondary address line (e.g., apartment, suite). |
| `property__useMailingAddressAsLocation` | integer | No | Set to 1 to use lead's mailing address as property location, 0 otherwise. If 1, lead's address overwrites property address. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Update policy by id

**Slug:** `AGENCYZOOM_UPDATE_A_POLICY`

Updates an existing insurance policy for the given `policyId`; monetary values must be in cents and dates in YYYY-MM-DD format.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `items` | integer | No | Number of items covered (e.g., vehicles for auto policy, properties for property policy). |
| `agentId` | integer | No | Unique identifier of the agent or producer who sold the policy. |
| `premium` | integer | No | Total premium amount for the policy term, in cents (e.g., $123.45 is 12345). |
| `policyId` | integer | Yes | Unique identifier of the policy to be updated (specified in the request path). |
| `soldDate` | string | No | Date policy was sold or bound (Format: YYYY-MM-DD). |
| `brokerFee` | integer | No | Broker fee for the policy, in cents (e.g., $50.00 is 5000). |
| `carrierId` | integer | No | Unique identifier of the insurance carrier. |
| `groupCode` | string | No | Code to associate the policy with a specific group for internal tracking or reporting. |
| `expiryDate` | string | No | Date policy coverage ends (Format: YYYY-MM-DD). |
| `policyType` | integer | No | Identifier for the type of policy transaction (e.g., New Business, Renewal). |
| `insuredName` | string | No | Name(s) of the insured party or parties (individual or company). |
| `agencyNumber` | string | No | Identifier for the agency branch or location associated with this policy. |
| `leadSourceId` | integer | No | Unique identifier for the lead source (e.g., referral, website). |
| `policyNumber` | string | No | Unique alphanumeric string assigned to the policy by the insurance carrier. |
| `effectiveDate` | string | No | Date policy coverage begins (Format: YYYY-MM-DD). |
| `departmentCode` | string | No | Code to assign the policy to a specific department (e.g., Personal Lines, Commercial Lines). |
| `priorExpiryDate` | string | No | Expiry date of the previous policy (Format: YYYY-MM-DD), if applicable. |
| `priorCarrierName` | string | No | Name of the previous insurance company, if applicable. |
| `priorPolicyNumber` | string | No | Policy number of the previous insurance policy, if applicable. |
| `productCategoryId` | integer | No | Identifier for the policy's product category (e.g., Auto, Home, Commercial). |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Update a vehicle's details

**Slug:** `AGENCYZOOM_UPDATE_A_VEHICLE_S_DETAILS`

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

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `vin` | string | No | The Vehicle Identification Number (VIN) of the vehicle. Typically a 17-character string. |
| `make` | string | No | The manufacturer of the vehicle. |
| `year` | integer | No | The manufacturing year of the vehicle. |
| `model` | string | No | The model of the vehicle. |
| `ownership` | string ("Financed" | "Leased" | "Owned") | No | The ownership status of the vehicle. Defaults to 'Owned' if unspecified or if an empty string is provided. |
| `vehicleId` | integer | Yes | The unique identifier of the opportunity vehicle to be updated. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Update business lead

**Slug:** `AGENCYZOOM_UPDATE_BUSINESS_LEAD`

Updates 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

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

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Update customer info using id

**Slug:** `AGENCYZOOM_UPDATE_CUSTOMER`

Updates an existing customer's information in AgencyZoom using their unique customerId.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `zip` | string | No | Postal or ZIP code of the customer's address. |
| `city` | string | No | City of the customer's address. |
| `csrId` | integer | No | The ID of the Customer Service Representative (CSR) assigned to the customer. |
| `email` | string | No | Customer's primary email address. |
| `phone` | string | No | Customer's primary phone number. |
| `state` | string | No | State or province of the customer's address (e.g., CA, NY). |
| `agentId` | integer | No | The ID of the producer or agent assigned to the customer. |
| `country` | string | No | Country of the customer's address (e.g., USA, Canada). |
| `birthday` | string | No | Customer's date of birth (MM/dd/YYYY format). |
| `lastname` | string | No | Customer's last name. |
| `tagNames` | string | No | Semicolon-separated string of tag names to associate with the customer (e.g., 'Lead;VIP;Past Client'). |
| `firstname` | string | No | Customer's first name. |
| `createDate` | string | No | Customer's creation date (MM/dd/YYYY format). |
| `customerId` | integer | Yes | Unique identifier for the customer to be updated. This value will also be used as the `customerId` in the API request path. |
| `bizCustomer` | integer | No | Indicates if the customer is a business. Use 1 for a business customer, 0 for an individual customer. |
| `customFields` | array | No | List of custom fields to update. Each item specifies `fieldName` and `fieldValue`. Date-type custom field values must be in 'MM/dd/YYYY' format. |
| `totalPayroll` | integer | No | Total payroll of the business. Applicable only if `bizCustomer` is 1 (commercial customer). |
| `annualRevenue` | integer | No | Annual revenue of the business. Applicable only if `bizCustomer` is 1 (commercial customer). |
| `streetAddress` | string | No | Customer's street address. |
| `secondaryEmail` | string | No | Customer's secondary email address. |
| `secondaryPhone` | string | No | Customer's secondary phone number. |
| `contactLastname` | string | No | Last name of the primary contact, typically for business customers. |
| `contactFirstname` | string | No | First name of the primary contact, typically for business customers. |
| `contactMiddlename` | string | No | Middle name of the primary contact, typically for business customers. |
| `numberOfEmployees` | integer | No | Number of employees. Applicable only if `bizCustomer` is 1 (commercial customer). |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Update lead

**Slug:** `AGENCYZOOM_UPDATE_LEAD`

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

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `zip` | string | No | Postal or ZIP code of the lead's address. |
| `city` | string | No | City of the lead's address. |
| `name` | string | No | Name of the organization, if the lead is a business entity. |
| `csrId` | integer | No | Identifier of the Customer Service Representative (CSR) assigned to the lead. |
| `email` | string | Yes | Lead's primary email address. |
| `notes` | string | No | Additional notes or comments related to the lead. |
| `phone` | string | No | Lead's primary phone number. |
| `state` | string | No | State or province of the lead's address. |
| `xDate` | string | No | 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. |
| `leadId` | integer | Yes | The unique identifier of the lead to be updated. |
| `country` | string | Yes | Country of the lead's address. |
| `stageId` | integer | Yes | Identifier of the stage the lead is currently in within the pipeline. |
| `assignTo` | string | Yes | Identifier of the primary producer or agent to whom the lead is assigned. |
| `birthday` | string | No | Lead's date of birth in MM/DD/YY format. |
| `lastname` | string | No | Lead's last name. |
| `nickname` | string | No | Lead's nickname. |
| `soldDate` | string | No | Date lead was marked as sold (e.g., YYYY-MM-DD). |
| `tagNames` | string | No | A single string containing tag names, separated by semicolons (e.g., 'Hot Lead;Follow Up Q3'). |
| `firstname` | string | Yes | Lead's first name. |
| `groupCode` | string | No | Group code associated with the lead. |
| `otherCsrs` | array | No | List of unique identifiers for other Customer Service Representatives (CSRs) also assigned to the lead. |
| `quoteDate` | string | No | Date quote was provided to the lead (e.g., YYYY-MM-DD). |
| `isBusiness` | boolean | No | Indicates if lead is a business entity (true) or an individual (false). |
| `middlename` | string | No | Lead's middle name. |
| `pipelineId` | integer | Yes | Identifier of the sales pipeline the lead belongs to. |
| `contactDate` | string | No | Last contact date (e.g., YYYY-MM-DD). |
| `agencyNumber` | string | No | Agency's location code associated with the lead. |
| `customFields` | array | No | A list of custom fields and their values to update for the lead. |
| `leadSourceId` | integer | Yes | Identifier of the source from which the lead originated. |
| `maritalStatus` | integer | No | Integer code representing the lead's marital status (e.g., 1 for Single, 2 for Married). Consult AgencyZoom documentation for specific codes. |
| `streetAddress` | string | No | Lead's street address. |
| `departmentCode` | string | No | Department code associated with the lead. |
| `otherProducers` | array | No | List of unique identifiers for other producers or agents also assigned to the lead. |
| `secondaryEmail` | string | No | Lead's secondary email address. |
| `secondaryPhone` | string | No | Lead's secondary phone number. |
| `assignmentGroupId` | integer | No | Identifier of the assignment group for the lead. |
| `nextExpirationDate` | string | No | Next policy expiration date relevant to the lead, in MM/DD/YY format. |
| `streetAddressLine2` | string | No | Additional line for the lead's street address. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Update lead status by id

**Slug:** `AGENCYZOOM_UPDATE_LEAD_STATUS_BY_ID`

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).

#### Input Parameters

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

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Update my profile

**Slug:** `AGENCYZOOM_UPDATE_MY_PROFILE`

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.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `email` | string | Yes | The user's email address. This must be unique within the AgencyZoom system. |
| `phone` | string | No | The user's optional phone number. |
| `lastname` | string | Yes | The user's last name. |
| `firstname` | string | Yes | The user's first name. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Add tags to a policy

**Slug:** `AGENCYZOOM_UPDATE_TAGS_FOR_A_POLICY`

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.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `policyId` | integer | No | The unique identifier of the policy within AgencyZoom. This field is ignored if `amsPolicyId` is provided. |
| `tagNames` | string | No | A comma-separated string of tag names to add to the policy. For example, 'New Lead,Follow Up'. |
| `amsPolicyId` | integer | No | 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

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Update task

**Slug:** `AGENCYZOOM_UPDATE_TASK`

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`.

#### Input Parameters

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

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Log user in via SSO

**Slug:** `AGENCYZOOM_V4_SSO_LOG_THE_USER_IN`

Logs a user into the AgencyZoom platform via Single Sign-On (SSO). Returns JWT on success or error details on authentication failure.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `password` | string | Yes | User's password for SSO authentication. |
| `username` | string | Yes | User's email address, serving as their username for the SSO login. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |