List bulk actions
List the conversation bulk actions run in your organization, newest first if you sort by created_at. Useful as an audit log of mass changes.
Endpoint
GET/conversations-bulk-actions
Query parameters
| Name | Type | Required | Description |
|---|---|---|---|
organization_id | integer | No | Organization. Results are always limited to organizations where your API key's user is owner or admin. |
action | string | No | assign, update_status, assign_ai_assistant, move or cut_ai_context. |
status | string | No | pending, processing, completed or failed. |
created_by_user_id | integer | No | User who ran the action. |
$limit / $skip | integer | No | Pagination. Default 10, max 50. |
$sort[created_at] | 1 | -1 | No | Sort order. |
Request
Response
json
The bulk action object
| Field | Type | Description |
|---|---|---|
id | integer | Read-only. Unique ID. |
organization_id | integer | Organization the action ran in. |
created_by_user_id | integer | Read-only. User who ran it (the API key's user). |
action | string | assign, update_status, assign_ai_assistant, move or cut_ai_context. |
action_params | object | null | Parameters sent with the action. |
conversation_ids | integer[] | null | Conversations targeted (resolved from filter when one was used). |
view_id | integer | null | Saved view ID. Not resolved by the server; always send conversation_ids or filter. |
filter | object | null | Filter used to pick the conversations: organization_id, pipeline_id, pipeline_stage_id, status, channel, assigned_user_id, assigned_ai_assistant_id. |
status | string | Read-only. pending, processing, completed or failed. |
processed_count | integer | Read-only. Conversations changed. |
failed_count | integer | Read-only. Conversations that could not be changed. |
error_message | string | null | Read-only. Error when the action failed. |
created_at | string (date-time) | Read-only. |
updated_at | string (date-time) | Read-only. |
deleted_at | string (date-time) | null | Read-only. |
Report an issue with this documentation
Please log in to report issues with our documentation.