Agencyzoom

Learn how to use Agencyzoom with Composio

Overview

SLUG: AGENCYZOOM

Description

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

Authentication Details

access_token
string
username
stringRequired
password
stringRequired
bearer_token
stringRequired

Connecting to Agencyzoom

Create an auth config

Use the dashboard to create an auth config for the Agencyzoom toolkit. This allows you to connect multiple Agencyzoom accounts to Composio for agents to use.

1

Select App

Navigate to the Agencyzoom toolkit page and click “Setup Integration”.

2

Configure Auth Config Settings

Select among the supported auth schemes of and configure them here.

3

Create and Get auth config ID

Click “Create Integration”. After creation, copy the displayed ID starting with ac_. This is your auth config ID. This is not a sensitive ID — you can save it in environment variables or a database. This ID will be used to create connections to the toolkit for a given user.

Connect Your Account

Using Basic With Jwt

1# Template not found: templates/python/basic_with_jwt.py

Using API Key

1from composio import Composio
2from composio.types import auth_scheme
3
4# Replace these with your actual values
5agencyzoom_auth_config_id = "ac_YOUR_AGENCYZOOM_CONFIG_ID" # Auth config ID created above
6user_id = "0000-0000-0000" # UUID from database/app
7
8composio = Composio()
9
10def authenticate_toolkit(user_id: str, auth_config_id: str):
11 # Replace this with a method to retrieve an API key from the user.
12 # Or supply your own.
13 user_api_key = input("[!] Enter API key")
14
15 connection_request = composio.connected_accounts.initiate(
16 user_id=user_id,
17 auth_config_id=auth_config_id,
18 config={"auth_scheme": "API_KEY", "val": user_api_key}
19 )
20
21 # API Key authentication is immediate - no redirect needed
22 print(f"Successfully connected Agencyzoom for user {user_id}")
23 print(f"Connection status: {connection_request.status}")
24
25 return connection_request.id
26
27
28connection_id = authenticate_toolkit(user_id, agencyzoom_auth_config_id)
29
30# You can verify the connection using:
31connected_account = composio.connected_accounts.get(connection_id)
32print(f"Connected account: {connected_account}")

Tools

Executing tools

To prototype you can execute some tools to see the responses and working on the Agencyzoom toolkit’s playground

Python
1from composio import Composio
2from openai import OpenAI
3import json
4
5openai = OpenAI()
6composio = Composio()
7
8# User ID must be a valid UUID format
9user_id = "0000-0000-0000" # Replace with actual user UUID from your database
10
11tools = composio.tools.get(user_id=user_id, toolkits=["AGENCYZOOM"])
12
13print("[!] Tools:")
14print(json.dumps(tools))
15
16def invoke_llm(task = "What can you do?"):
17 completion = openai.chat.completions.create(
18 model="gpt-4o",
19 messages=[
20 {
21 "role": "user",
22 "content": task, # Your task here!
23 },
24 ],
25 tools=tools,
26 )
27
28 # Handle Result from tool call
29 result = composio.provider.handle_tool_calls(user_id=user_id, response=completion)
30 print(f"[!] Completion: {completion}")
31 print(f"[!] Tool call result: {result}")
32
33invoke_llm()

Tool List

Tool Name: Get a list of producers

Description

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

Action Parameters

Action Response

data
objectRequired
error
string
successful
booleanRequired

Tool Name: Authenticate for JWT via V4 SSO

Description

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

Action Parameters

code
string

Action Response

data
objectRequired
error
string
successful
booleanRequired

Tool Name: Batch create contacts

Description

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

Action Parameters

contactDataRequests
array

Action Response

data
objectRequired
error
string
successful
booleanRequired

Tool Name: Batch create leads

Description

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.

Action Parameters

leadDataRequests
array

Action Response

data
objectRequired
error
string
successful
booleanRequired

Tool Name: Batch delete tasks

Description

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

Action Parameters

taskIds
array

Action Response

data
objectRequired
error
string
successful
booleanRequired

Tool Name: Change lead status

Description

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.

Action Parameters

changeLeadSourceTo
integer
date
string
leadId
integerRequired
lossReasonId
integer
recycleToPipeline
integer
recycleToStage
integer
status
integerRequired
tagIds
array
toStageId
integer
workflowId
integer
workflowStageId
integer
xDateType
string

Action Response

data
objectRequired
error
string
successful
booleanRequired

Tool Name: Mark task as completed

Description

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

Action Parameters

taskId
integerRequired

Action Response

data
objectRequired
error
string
successful
booleanRequired

Tool Name: Create an opportunity

Description

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

Action Parameters

carrierId
integer
customFields
array
customerReferralId
integerRequired
expiryDate
string
items
integerDefaults to 1
premium
integer
productLineId
integerRequired
property__address1
string
property__address2
string
property__city
string
property__country
string
property__state
string
property__useMailingAddressAsLocation
integer
property__zip
string

Action Response

data
objectRequired
error
string
successful
booleanRequired

Tool Name: Create a customer note

Description

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

Action Parameters

customerId
integerRequired
note
stringRequired

Action Response

data
objectRequired
error
string
successful
booleanRequired

Tool Name: Create a driver for an opportunity

Description

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

Action Parameters

opportunityId
integerRequired

Action Response

data
objectRequired
error
string
successful
booleanRequired

Tool Name: Create a lead note

Description

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

Action Parameters

leadId
integerRequired
note
stringRequired

Action Response

data
objectRequired
error
string
successful
booleanRequired

Tool Name: Create a lead opportunity

Description

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.

Action Parameters

carrierId
integerRequired
customFields
array
items
integerDefaults to 1
leadId
integerRequired
premium
integerRequired
productLineId
integerRequired

Action Response

data
objectRequired
error
string
successful
booleanRequired

Tool Name: Create a lead quote

Description

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.

Action Parameters

carrierId
integerRequired
customFields
array
items
integerRequired
leadId
integerRequired
premium
integerRequired
productLineId
integerRequired

Action Response

data
objectRequired
error
string
successful
booleanRequired

Tool Name: Create a vehicle for an opportunity

Description

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

Action Parameters

make
stringRequired
model
string
opportunityId
integerRequired
ownership
string
vin
string
year
integer

Action Response

data
objectRequired
error
string
successful
booleanRequired

Tool Name: Create business lead

Description

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

Action Parameters

Action Response

data
objectRequired
error
string
successful
booleanRequired

Tool Name: Create lead

Description

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

Action Parameters

agencyNumber
string
assignTo
stringRequired
assignmentGroupId
integer
birthday
string
city
string
contactDate
string
country
stringRequired
csrId
integer
customFields
array
departmentCode
string
email
stringRequired
firstname
stringRequired
groupCode
string
isBusiness
boolean
lastname
string
leadSourceId
integerRequired
maritalStatus
integer
middlename
string
name
string
nextExpirationDate
string
nickname
string
notes
string
otherCsrs
array
otherProducers
array
phone
string
pipelineId
integerRequired
quoteDate
string
secondaryEmail
string
secondaryPhone
string
soldDate
string
stageId
integerRequired
state
string
streetAddress
string
streetAddressLine2
string
tagNames
string
xDate
string
zip
string

Action Response

data
objectRequired
error
string
successful
booleanRequired

Tool Name: Create task post endpoint

Description

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.

Action Parameters

assigneeId
integer
comments
string
contactEmail
string
customerId
integer
dueDatetime
string
duration
integer
invitees
array
leadId
integer
lifeProfessionalId
integer
timeSpecific
boolean
title
string
type
string

Action Response

data
objectRequired
error
string
successful
booleanRequired

Tool Name: Delete an opportunity

Description

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

Action Parameters

opportunityId
integerRequired

Action Response

data
objectRequired
error
string
successful
booleanRequired

Tool Name: Delete a customer

Description

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

Action Parameters

customerId
integerRequired

Action Response

data
objectRequired
error
string
successful
booleanRequired

Tool Name: Delete customer file

Description

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

Action Parameters

customerId
integerRequired
fileId
integerRequired

Action Response

data
objectRequired
error
string
successful
booleanRequired

Tool Name: Delete a customer policy

Description

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

Action Parameters

customerId
integerRequired
policyId
integerRequired

Action Response

data
objectRequired
error
string
successful
booleanRequired

Tool Name: Delete an opportunity driver by ID

Description

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

Action Parameters

driverId
integerRequired

Action Response

data
objectRequired
error
string
successful
booleanRequired

Tool Name: Delete file from lead

Description

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

Action Parameters

fileId
integerRequired
leadId
integerRequired

Action Response

data
objectRequired
error
string
successful
booleanRequired

Tool Name: Delete a lead opportunity

Description

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.

Action Parameters

leadId
integerRequired
opportunityId
integerRequired

Action Response

data
objectRequired
error
string
successful
booleanRequired

Tool Name: Delete a lead quote

Description

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

Action Parameters

leadId
integerRequired
quoteId
integerRequired

Action Response

data
objectRequired
error
string
successful
booleanRequired

Tool Name: Delete a task

Description

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

Action Parameters

taskId
integerRequired

Action Response

data
objectRequired
error
string
successful
booleanRequired

Tool Name: Delete a vehicle

Description

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

Action Parameters

vehicleId
integerRequired

Action Response

data
objectRequired
error
string
successful
booleanRequired

Tool Name: Delete thread message

Description

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

Action Parameters

Action Response

data
objectRequired
error
string
successful
booleanRequired

Tool Name: Delete email thread

Description

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

Action Parameters

Action Response

data
objectRequired
error
string
successful
booleanRequired

Tool Name: Get AMS policies for a customer

Description

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.

Action Parameters

customerId
integerRequired

Action Response

data
objectRequired
error
string
successful
booleanRequired

Tool Name: Get auth URL for V4 SSO

Description

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.

Action Parameters

Action Response

data
objectRequired
error
string
successful
booleanRequired

Tool Name: Get a list of assign groups

Description

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

Action Parameters

Action Response

data
arrayRequired
error
string
successful
booleanRequired

Tool Name: Get a list of carriers

Description

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

Action Parameters

Action Response

data
arrayRequired
error
string
successful
booleanRequired

Tool Name: Get a list of CSRs

Description

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

Action Parameters

Action Response

data
objectRequired
error
string
successful
booleanRequired

Tool Name: Get a list of custom fields

Description

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

Action Parameters

Action Response

data
arrayRequired
error
string
successful
booleanRequired

Tool Name: Get a list of drivers for an opportunity

Description

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

Action Parameters

opportunityId
integerRequired

Action Response

data
arrayRequired
error
string
successful
booleanRequired

Tool Name: Get a list of employees

Description

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

Action Parameters

Action Response

data
arrayRequired
error
string
successful
booleanRequired

Tool Name: Get lead sources

Description

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

Action Parameters

Action Response

data
arrayRequired
error
string
successful
booleanRequired

Tool Name: Get lead source categories

Description

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

Action Parameters

Action Response

data
arrayRequired
error
string
successful
booleanRequired

Tool Name: Get a list of life professionals

Description

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

Action Parameters

Action Response

data
arrayRequired
error
string
successful
booleanRequired

Tool Name: Get a list of locations

Description

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

Action Parameters

Action Response

data
arrayRequired
error
string
successful
booleanRequired

Tool Name: Get loss reasons

Description

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

Action Parameters

Action Response

data
arrayRequired
error
string
successful
booleanRequired

Tool Name: Get a list of pipelines

Description

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.

Action Parameters

Action Response

data
arrayRequired
error
string
successful
booleanRequired

Tool Name: Get product lines and policy types

Description

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

Action Parameters

Action Response

data
arrayRequired
error
string
successful
booleanRequired

Tool Name: Get a list of recycle events

Description

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

Action Parameters

leadId
integerRequired

Action Response

data
objectRequired
error
string
successful
booleanRequired

Tool Name: Retrieve vehicles for opportunity

Description

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

Action Parameters

opportunityId
integerRequired

Action Response

data
arrayRequired
error
string
successful
booleanRequired

Tool Name: Get departments groups

Description

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

Action Parameters

agencyNumber
string

Action Response

data
objectRequired
error
string
successful
booleanRequired

Tool Name: Get lead files

Description

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

Action Parameters

Action Response

data
arrayRequired
error
string
successful
booleanRequired

Tool Name: Retrieve notes for specific lead

Description

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.

Action Parameters

leadId
integerRequired

Action Response

data
arrayRequired
error
string
successful
booleanRequired

Tool Name: Get lead quotes

Description

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

Action Parameters

leadId
integerRequired

Action Response

data
arrayRequired
error
string
successful
booleanRequired

Tool Name: Get lead tasks

Description

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

Action Parameters

leadId
integerRequired

Action Response

data
arrayRequired
error
string
successful
booleanRequired

Tool Name: Get list of end stages

Description

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

Action Parameters

Action Response

data
arrayRequired
error
string
successful
booleanRequired

Tool Name: Get policies for a customer

Description

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

Action Parameters

customerId
integerRequired

Action Response

data
objectRequired
error
string
successful
booleanRequired

Tool Name: Get the customer details

Description

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

Action Parameters

customerId
integerRequired

Action Response

data
objectRequired
error
string
successful
booleanRequired

Tool Name: Get the customer tasks

Description

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.

Action Parameters

customerId
integerRequired

Action Response

data
arrayRequired
error
string
successful
booleanRequired

Tool Name: Get the driver details

Description

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

Action Parameters

driverId
integerRequired

Action Response

data
objectRequired
error
string
successful
booleanRequired

Tool Name: Get the lead details

Description

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.

Action Parameters

leadId
integerRequired

Action Response

data
objectRequired
error
string
successful
booleanRequired

Tool Name: Get the opportunities for a lead

Description

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

Action Parameters

leadId
integerRequired

Action Response

data
arrayRequired
error
string
successful
booleanRequired

Tool Name: Get the opportunity details

Description

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

Action Parameters

opportunityId
integerRequired

Action Response

data
objectRequired
error
string
successful
booleanRequired

Tool Name: Get the task details

Description

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

Action Parameters

taskId
integerRequired

Action Response

data
objectRequired
error
string
successful
booleanRequired

Tool Name: Get the vehicle details

Description

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

Action Parameters

vehicleId
integerRequired

Action Response

data
objectRequired
error
string
successful
booleanRequired

Tool Name: Get thread details

Description

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

Action Parameters

Action Response

data
objectRequired
error
string
successful
booleanRequired

Tool Name: List Product Categories

Description

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

Action Parameters

Action Response

data
arrayRequired
error
string
successful
booleanRequired

Tool Name: Log the user in

Description

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.

Action Parameters

password
stringRequired
username
stringRequired

Action Response

data
objectRequired
error
string
successful
booleanRequired

Tool Name: Log the user out

Description

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

Action Parameters

Action Response

data
objectRequired
error
string
successful
booleanRequired

Tool Name: Mark thread as unread

Description

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.

Action Parameters

markUnread
boolean
threadId
string

Action Response

data
objectRequired
error
string
successful
booleanRequired

Tool Name: Move lead to sold

Description

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.

Action Parameters

keepOpen
boolean
leadId
integerRequired
soldProducts
arrayRequired

Action Response

data
objectRequired
error
string
successful
booleanRequired

Tool Name: Remove text thread

Description

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

Action Parameters

Action Response

data
objectRequired
error
string
successful
booleanRequired

Tool Name: Reopen a task

Description

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

Action Parameters

comments
string
taskId
integerRequired

Action Response

data
objectRequired
error
string
successful
booleanRequired

Tool Name: Search business classifications

Description

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

Action Parameters

Action Response

data
arrayRequired
error
string
successful
booleanRequired

Tool Name: Search customers

Description

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

Action Parameters

Action Response

data
objectRequired
error
string
successful
booleanRequired

Tool Name: Search email threads

Description

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.

Action Parameters

Action Response

data
objectRequired
error
string
successful
booleanRequired

Tool Name: Search leads

Description

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

Action Parameters

Action Response

data
objectRequired
error
string
successful
booleanRequired

Tool Name: Search leads count

Description

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.

Action Parameters

Action Response

data
objectRequired
error
string
successful
booleanRequired

Tool Name: Search life and health leads

Description

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.

Action Parameters

Action Response

data
objectRequired
error
string
successful
booleanRequired

Tool Name: Search SMS threads

Description

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

Action Parameters

Action Response

data
objectRequired
error
string
successful
booleanRequired

Tool Name: Search and list tasks

Description

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

Action Parameters

Action Response

data
objectRequired
error
string
successful
booleanRequired

Tool Name: List service tickets

Description

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

Action Parameters

Action Response

data
objectRequired
error
string
successful
booleanRequired

Tool Name: Get text thread details

Description

Retrieves detailed messages for an implicitly specified text thread.

Action Parameters

Action Response

data
objectRequired
error
string
successful
booleanRequired

Tool Name: Unread email thread

Description

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

Action Parameters

markUnread
boolean
threadId
string

Action Response

data
objectRequired
error
string
successful
booleanRequired

Tool Name: Update an opportunity

Description

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

Action Parameters

carrierId
integer
customFields
array
expiryDate
string
items
integerDefaults to 1
premium
integer
productLineId
integer
property__address1
string
property__address2
string
property__city
string
property__country
string
property__state
string
property__useMailingAddressAsLocation
integer
property__zip
string

Action Response

data
objectRequired
error
string
successful
booleanRequired

Tool Name: Update a driver’s details

Description

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

Action Parameters

birthday
string
driverId
integerRequired
firstName
stringRequired
gender
string
lastName
stringRequired
licenseNumber
string
maritalStatus
integer
middleName
string
relationship
string
stateLicensed
string

Action Response

data
objectRequired
error
string
successful
booleanRequired

Tool Name: Rename lead file

Description

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

Action Parameters

customerReferralId
integer
fileId
integer
leadId
integerRequired
newFileName
string

Action Response

data
objectRequired
error
string
successful
booleanRequired

Tool Name: Update a lead opportunity

Description

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.

Action Parameters

carrierId
integerRequired
customFields
array
id
integerRequired
items
integerDefaults to 1
leadId
integerRequired
premium
integerRequired
productLineId
integerRequired

Action Response

data
objectRequired
error
string
successful
booleanRequired

Tool Name: Update lead quote data

Description

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.

Action Parameters

carrierId
integerRequired
customFields
array
id
integerRequired
items
integerRequired
leadId
integerRequired
premium
integerRequired
productLineId
integerRequired

Action Response

data
objectRequired
error
string
successful
booleanRequired

Tool Name: Update policy by id

Description

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

Action Parameters

agencyNumber
stringRequired
agentId
integerRequired
brokerFee
integer
carrierId
integerRequired
departmentCode
string
effectiveDate
stringRequired
expiryDate
stringRequired
groupCode
string
insuredName
string
items
integerRequired
leadSourceId
integerRequired
policyId
integerRequired
policyNumber
string
policyType
integerRequired
premium
integerRequired
priorCarrierName
string
priorExpiryDate
string
priorPolicyNumber
string
productCategoryId
integerRequired
soldDate
stringRequired

Action Response

data
objectRequired
error
string
successful
booleanRequired

Tool Name: Update a vehicle’s details

Description

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

Action Parameters

make
stringRequired
model
string
ownership
string
vehicleId
integerRequired
vin
string
year
integer

Action Response

data
objectRequired
error
string
successful
booleanRequired

Tool Name: Update business lead

Description

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

Action Parameters

leadId
integerRequired

Action Response

data
objectRequired
error
string
successful
booleanRequired

Tool Name: Update customer info using id

Description

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

Action Parameters

agentId
integer
annualRevenue
integer
birthday
string
bizCustomer
integer
city
string
contactFirstname
string
contactLastname
string
contactMiddlename
string
country
string
createDate
string
csrId
integer
customFields
array
customerId
integerRequired
email
string
firstname
string
lastname
string
numberOfEmployees
integer
phone
string
secondaryEmail
string
secondaryPhone
string
state
string
streetAddress
string
tagNames
string
totalPayroll
integer
zip
string

Action Response

data
objectRequired
error
string
successful
booleanRequired

Tool Name: Update lead

Description

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

Action Parameters

agencyNumber
string
assignTo
stringRequired
assignmentGroupId
integer
birthday
string
city
string
contactDate
string
country
stringRequired
csrId
integer
customFields
array
departmentCode
string
email
stringRequired
firstname
stringRequired
groupCode
string
isBusiness
boolean
lastname
string
leadId
integerRequired
leadSourceId
integerRequired
maritalStatus
integer
middlename
string
name
string
nextExpirationDate
string
nickname
string
notes
string
otherCsrs
array
otherProducers
array
phone
string
pipelineId
integerRequired
quoteDate
string
secondaryEmail
string
secondaryPhone
string
soldDate
string
stageId
integerRequired
state
string
streetAddress
string
streetAddressLine2
string
tagNames
string
xDate
string
zip
string

Action Response

data
objectRequired
error
string
successful
booleanRequired

Tool Name: Update lead status by id

Description

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

Action Parameters

changeLeadSourceTo
integer
date
string
leadId
integerRequired
lossReasonId
integer
recycleToPipeline
integer
recycleToStage
integer
status
integerRequired
tagIds
array
toStageId
integer
workflowId
integer
workflowStageId
integer
xDateType
string

Action Response

data
objectRequired
error
string
successful
booleanRequired

Tool Name: Update my profile

Description

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.

Action Parameters

email
stringRequired
firstname
stringRequired
lastname
stringRequired
phone
string

Action Response

data
objectRequired
error
string
successful
booleanRequired

Tool Name: Add tags to a policy

Description

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.

Action Parameters

amsPolicyId
integer
policyId
integer
tagNames
string

Action Response

data
objectRequired
error
string
successful
booleanRequired

Tool Name: Update task

Description

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

Action Parameters

taskId
integerRequired

Action Response

data
objectRequired
error
string
successful
booleanRequired

Tool Name: Log user in via SSO

Description

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

Action Parameters

password
stringRequired
username
stringRequired

Action Response

data
objectRequired
error
string
successful
booleanRequired