Skip to main content
POST
/
api
/
v1
/
accounts
/
{account_id}
/
leads
/
bulk
Bulk action on leads
curl --request POST \
  --url https://connect.voxys.ai/api/v1/accounts/{account_id}/leads/bulk \
  --header 'Content-Type: application/json' \
  --header 'api_access_token: <api-key>' \
  --data '
{
  "lead_ids": [
    1,
    2,
    3
  ],
  "action_type": "assign",
  "params": {
    "assigned_agent_id": 5
  }
}
'
{
  "success": true,
  "affected_count": 3
}

Documentation Index

Fetch the complete documentation index at: https://developers.voxys.ai/llms.txt

Use this file to discover all available pages before exploring further.

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:
[1, 2, 3]
​
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:
{ "assigned_agent_id": 5 }

Response

Bulk action completed.

​
success
boolean
Example:

true

​
affected_count
integer
Example:

3