Account

Accounts represent potential customers. The object contains information about the location and current status of the account.

📄️ Add Account

Adds a new account and returns the created object.

📄️ Batch Accounts

Processes a mixed batch of account add, update, and remove operations, up to 20 operations per request. Each operation returns its own success or error result and enforces its corresponding permission.

📄️ Bulk Modify Accounts

Applies one or more bulk actions to all accounts matching the provided filter. Supported actions are `updateStatus`, `updateStage`, `updateCustomField`, `clearDisposition`, and `delete`. Unchanged accounts are skipped. Requires the `workflow:manage` permission.

📄️ Get Account

Retrieves an account by its ID.

📄️ List Accounts

Lists all accounts, or a subset thereof.

📄️ Match Account

Finds an existing account using a cascading match strategy. Tries each provided criterion in priority order — accountId, externalLeadId, sourceId, then address — and returns the first match found. When matching by address, additional accounts at the same location may also be returned.

📄️ Remove Account

Removes (deletes) an existing account. Requires the `account:manage` permission.

📄️ Update Account

Updates an existing account and returns the updated object.

📄️ Upsert Account

Creates or updates an account based on provided data. Use the 'requestType' field to control behavior: 'add' errors if the account already exists, 'update' errors if the account does not exist, and 'upsert' (default) creates or updates as needed.

📄️ Account Webhooks

This webhook is triggered when an action is taken on an account.