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

NameTypeRequiredDescription
organization_idintegerNoOrganization. Results are always limited to organizations where your API key's user is owner or admin.
actionstringNoassign, update_status, assign_ai_assistant, move or cut_ai_context.
statusstringNopending, processing, completed or failed.
created_by_user_idintegerNoUser who ran the action.
$limit / $skipintegerNoPagination. Default 10, max 50.
$sort[created_at]1 | -1NoSort order.

Request

Response

json

The bulk action object

FieldTypeDescription
idintegerRead-only. Unique ID.
organization_idintegerOrganization the action ran in.
created_by_user_idintegerRead-only. User who ran it (the API key's user).
actionstringassign, update_status, assign_ai_assistant, move or cut_ai_context.
action_paramsobject | nullParameters sent with the action.
conversation_idsinteger[] | nullConversations targeted (resolved from filter when one was used).
view_idinteger | nullSaved view ID. Not resolved by the server; always send conversation_ids or filter.
filterobject | nullFilter used to pick the conversations: organization_id, pipeline_id, pipeline_stage_id, status, channel, assigned_user_id, assigned_ai_assistant_id.
statusstringRead-only. pending, processing, completed or failed.
processed_countintegerRead-only. Conversations changed.
failed_countintegerRead-only. Conversations that could not be changed.
error_messagestring | nullRead-only. Error when the action failed.
created_atstring (date-time)Read-only.
updated_atstring (date-time)Read-only.
deleted_atstring (date-time) | nullRead-only.

Report an issue with this documentation

Please log in to report issues with our documentation.