Skip to main content
POST
Bulk action on leads

Authorizations

api_access_token
string
header
required

API access token for authentication. Obtain from your Voxys Connect profile settings.

Path Parameters

account_id
integer
required

The numeric ID of the account.

Body

application/json
lead_ids
integer[]
required
Example:
action_type
enum<string>
required
Available options:
assign,
status_change,
delete
Example:

"assign"

params
object

Additional params depending on action_type, e.g. {"assigned_agent_id": 5} or {"status": "won"}

Example:

Response

Bulk action completed.

success
boolean
Example:

true

affected_count
integer
Example:

3