Agencyzoom

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.

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

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.

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

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.

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

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

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

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.

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

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.

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.

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

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

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

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.

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

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

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

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

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

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

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.

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

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

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

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.

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

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.

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.

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

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

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

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

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

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

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

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

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

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

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.

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.

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

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

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

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

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

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.

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.

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

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

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

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

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

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.

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

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.

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

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

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

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

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

Assigns or reassigns an existing driver to an existing 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.

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

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.

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

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.

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.

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.

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

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

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

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.

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

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.

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.

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

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

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

Retrieves detailed messages for an implicitly specified text thread.

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.

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

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

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

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

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

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.

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.

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

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

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.

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

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

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

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.

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.

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

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