Authenticate for JWT via V4 SSOAuthenticates 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.
Batch create contactsCreates 1 to 5 new contacts in agencyzoom in a single batch api call.
Batch create leadsCreates up to 5 new leads in agencyzoom; all referenced entity ids (e.
Batch delete tasksDeletes multiple agencyzoom tasks in a batch; task deletion is permanent and the response indicates overall batch success, not individual task status.
Change lead statusUpdates a lead's lifecycle status (e.
Mark task as completedMarks an existing and accessible task in agencyzoom as 'completed'; this action does not return the full updated task object.
Create a customer noteAdds a new note to an existing customer's profile using their id; cannot be used to edit or retrieve existing notes.
Create a driver for an opportunityCreates 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.
Create a lead noteAdds a new note to an existing lead in agencyzoom, identified by `leadid`.
Create a lead opportunityAdds a new sales opportunity to an existing lead in agencyzoom, requiring a valid `leadid`, `carrierid`, `productlineid`, and that custom field names match existing definitions in agencyzoom.
Create a lead quoteCreates a new insurance quote for an existing lead in agencyzoom, using valid carrier and product line ids, to track a proposal; this action does not bind policies or process payments.
Create an opportunityCreates a new lead opportunity in agencyzoom; this action cannot update existing opportunities.
Create a vehicle for an opportunityAdds a new vehicle record to a specified opportunity; `opportunityid` must refer to a valid, existing opportunity.
Create business leadCreates or updates a business lead in agencyzoom using detailed personal and company information, for b2b sales and marketing lead management.
Create leadCreates a new lead or updates an existing one in agencyzoom; ensure `pipelineid`, `stageid`, `leadsourceid`, and `assignto` reference valid, existing entities.
Create task post endpointCreates 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.
Delete a customerIrreversibly deletes a customer and all associated data in agencyzoom using their `customerid`; useful for offboarding or data privacy compliance.
Delete customer filePermanently deletes a specific file, identified by `fileid`, associated with a customer, identified by `customerid`.
Delete a customer policyPermanently deletes a specific policy associated with a customer, for instance, if it's cancelled or inactive; this action is irreversible and requires caution.
Delete an opportunity driver by IDPermanently deletes an existing agencyzoom driver (e.
Delete file from leadDeletes a specific file (identified by `fileid`) associated with an existing lead (identified by `leadid`); this operation is irreversible.
Delete a lead opportunityPermanently deletes an existing opportunity (by `opportunityid`) associated with an existing lead (by `leadid`) when it's irrelevant, closed, or erroneous; the lead itself remains.
Delete a lead quoteDeletes a specific quote from a lead, requiring that the lead and quote exist and are associated.
Delete an opportunityPermanently deletes a specific opportunity by its unique id; this action is irreversible and requires a valid, existing `opportunityid`.
Delete a taskPermanently and irreversibly deletes an existing task, identified by its `taskid`.
Delete a vehiclePermanently deletes a vehicle record by its `vehicleid`, which must correspond to an existing vehicle in the agencyzoom system.
Delete thread messageDeletes a specific message from an email thread within agencyzoom, where the message id is implicitly handled (e.
Delete email threadPermanently deletes a specific email thread from the agencyzoom system, identified by its `threadid` (expected by the endpoint), provided the thread exists.
Get a list of assign groupsRetrieves all assign groups configured in agencyzoom, used for categorizing or assigning items to specific teams or units.
Get a list of carriersRetrieves all insurance carriers from agencyzoom, typically used for populating selection lists or synchronizing carrier data; does not return detailed policy or coverage information.
Get a list of CSRsFetches all customer service representatives (csrs), including their id and name, returning an empty list if none are configured.
Get a list of custom fieldsRetrieves metadata for all configured custom field definitions, not the specific values entered for individual records.
Get a list of drivers for an opportunityRetrieves a list of drivers (individuals), including their personal details, licensing information, and relationship status, associated with a specific, existing `opportunityid` in agencyzoom.
Get a list of employeesRetrieves a complete list of all employees for the authenticated agency; returns an empty list if no employees are configured.
Get lead source categoriesRetrieves a comprehensive list of all predefined lead source categories from agencyzoom, used to classify lead origins.
Get lead sourcesFetches a list of all lead sources configured in agencyzoom, including their id, name, sales exclusion status, and category id.
Get a list of life professionalsRetrieves a list of life insurance professionals, including only their contact and status information (excluding sales or customer data), from the agencyzoom platform.
Get a list of locationsRetrieves all agency locations or branches from agencyzoom; filtering options are not available.
Get loss reasonsRetrieves a list of all predefined loss reasons from agencyzoom, used for populating ui elements or analysis, returning all reasons without filtering or statistical data.
Get a list of pipelinesRetrieves all pipelines and their stages from agencyzoom to understand workflow structures; this is a read-only operation and does not return individual items (like leads or tasks) within these pipelines.
Get a list of producersRetrieves a list of all producers from agencyzoom, typically related to text thread functionalities.
Get product lines and policy typesFetches all product lines and policy types from agencyzoom, each detailed with its id, name, and product category id.
Get a list of recycle eventsRetrieves the history of recycling activities (e.
Retrieve vehicles for opportunityRetrieves all vehicles associated with an existing opportunity, using its unique opportunityid.
Get AMS policies for a customerRetrieves a customer's synchronized agency management system (ams) policy data (typically a single policy); requires an active ams integration, may return empty/default values if data is missing.
Get auth URL for V4 SSORetrieves a fresh authentication url for agencyzoom's v4 single sign-on (sso) process; call before each sso attempt as the url may change and should not be cached.
Get departments groupsFetches department and group information for an agency, optionally filtered by a specific `agencynumber`, to analyze its organizational structure.
Get lead filesRetrieves 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.
Retrieve notes for specific leadFetches 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.
Get lead quotesRetrieves all insurance quotes (active and inactive) for a specific lead id, useful for reviewing or tracking quote history.
Get lead tasksRetrieves all tasks for a specific lead, identified by its `leadid`, to review its activity history or manage follow-ups.
Get list of end stagesFetches a list of all defined end stages, representing final steps in processes like lead conversion or policy closure.
Get policies for a customerRetrieves from agencyzoom details for an insurance policy of an existing customer (identified by `customerid`), excluding premium payment history or claims information.
Get the customer detailsFetches comprehensive details for a specific customer, including personal information, policies, notes, tasks, files, and custom fields, using their unique customer id.
Get the customer tasksFetches 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.
Get the driver detailsRetrieves detailed information for a specific, existing driver (by `driverid`) associated with an agencyzoom opportunity.
Get the lead detailsRetrieves comprehensive details for a specific lead in agencyzoom by its unique `leadid` (which must correspond to an existing lead), including contact information, status, associated opportunities, quotes/policies, custom fields, and interaction history.
Get the opportunities for a leadRetrieves all sales opportunities and their details for a specified, existing `leadid` in agencyzoom.
Get the opportunity detailsFetches comprehensive details for an existing opportunity using its unique `opportunityid`.
Get the task detailsRetrieves comprehensive details for a specific task using its unique `taskid`, which must correspond to an existing task in agencyzoom.
Get the vehicle detailsRetrieves detailed information for a specific vehicle, often associated with an agencyzoom opportunity, using its unique vehicleid.
Get thread detailsSearches and retrieves detailed information for email threads in agencyzoom; no explicit search criteria are passed in this request.
Link a driver to opportunityAssigns or reassigns an existing driver to an existing opportunity.
Link vehicle to opportunityLinks an existing vehicle to an existing sales opportunity in agencyzoom using their respective ids, typically for managing auto insurance policies or related services.
List Product CategoriesRetrieves a complete, unfiltered list of all product categories (id and name) from agencyzoom, useful for understanding product organization or populating ui elements.
Log the user inAuthenticates an existing agencyzoom user using their email (as username) and password to obtain a jwt for api access; this action does not support new user creation.
Log the user outUse this action to log the current user out of agencyzoom by invalidating their active session token.
Mark thread as unreadMarks 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.
Move lead to soldMarks an existing lead as sold by its `leadid` and records product details; `productlineid`, `premium`, `effectivedate`, and `solddate` are operationally required for each sold product, despite schema flexibility.
Remove text threadCall 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.
Reopen a taskReopens an existing agencyzoom task that is currently 'completed' or 'closed', allowing it to be reactivated with optional comments.
Search business classificationsRetrieves a comprehensive list of all available business classifications from agencyzoom, each including an id, code, and description.
Search customersSearches for customers in agencyzoom using criteria like contact information, policy details, or custom fields, with options for filtering, sorting, and pagination.
Search email threadsRetrieves a list of email thread metadata from agencyzoom, suitable for an overview when no specific filtering, sorting, or pagination is needed, as results are subject to default server-side limits and ordering.
Search leadsRetrieves agencyzoom leads, using filters, pagination, and sorting options sent in the post body, as the request schema itself is empty.
Search leads countRetrieves a summary of lead counts categorized by workflow stage from agencyzoom; this action does not support filtering and returns aggregate counts rather than individual lead details.
Search life and health leadsSearches 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.
Search SMS threadsSearches and retrieves sms threads from agencyzoom, with search parameters, filters, sorting, and pagination typically provided in the request body of this post operation.
Search and list tasksSearches and lists tasks, supporting pagination and accepting filter criteria in the post request body despite an empty request schema.
List service ticketsRetrieves a list of service tickets from agencyzoom, optionally filtered by criteria such as status, priority, or date ranges.
Get text thread detailsRetrieves detailed messages for an implicitly specified text thread.
Unlink driver from opportunityUnlinks 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.
Unlink vehicle from opportunityUnlinks a specific, existing vehicle from a specific, existing opportunity using their respective ids, removing only the association and not the records themselves.
Unread email threadUpdates the read or unread status of a specific email thread within agencyzoom.
Update a driver's detailsUpdates an existing driver's details in agencyzoom, requiring `driverid` in the path and `firstname` and `lastname` in the request.
Rename lead fileUpdates 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`.
Update a lead opportunityUpdates an existing opportunity's details (carrier, product line, premium, items, custom fields) for a specific lead; `leadid`, opportunity `id`, `carrierid`, and `productlineid` must refer to existing entities.
Update lead quote dataUpdates 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.
Update an opportunityUpdates an existing opportunity with the provided details; ensure any custom field names are predefined in agencyzoom configuration.
Update policy by idUpdates an existing insurance policy for the given `policyid`; monetary values must be in cents and dates in yyyy-mm-dd format.
Update a vehicle's detailsUpdates details for an existing vehicle within an opportunity; this action cannot be used to create new vehicle records.
Update business leadUpdates 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.
Update customer info using idUpdates an existing customer's information in agencyzoom using their unique customerid.
Update leadUpdates an existing lead's information in agencyzoom using the `leadid`; ensure the `leadid` corresponds to an existing lead in agencyzoom.
Update lead status by idUpdates a lead's status (0=active, 2=won, 3=lost, 5=xdated) by `leadid`, optionally setting workflow, stage, date, loss reason, x-date type, source, recycle stage/pipeline, or tags; requires `date` and `xdatetype` for status 5 (xdated), and `lossreasonid` for status 3 (lost).
Update my profileUpdates the profile information (first name, last name, email, and optional phone) for the currently authenticated user in agencyzoom; the provided email address must be unique within the system.
Add tags to a policyAdds new comma-separated `tagnames` to a policy, requiring `tagnames` and identification by either `policyid` or `amspolicyid`; if `amspolicyid` is provided, `policyid` is ignored, and existing tags are not affected.
Update taskModifies 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`.
Log user in via SSOLogs a user into the agencyzoom platform via single sign-on (sso).
