Skip to main content
Batch methods let you run the same operation on multiple resources at once, reducing the number of requests needed to manage your license at scale. Each item in a batch is processed concurrently — the response is returned as an array in the same order as the request.
Batch requests require the same scopes as their non-batch equivalents. It’s not possible to mix different methods in a single batch request.

​
How it works

Send a POST request to the batch method URL with a requests array. Each object in the array is a standard request payload for the corresponding method. There’s no guarantee on execution order, but the response array preserves the order of the input.
Request format
{
  "requests": [
    { <request object> },
    { <another request object> }
  ]
}
Response format
{
  "responses": [
    { <response object or error> },
    { <another response object or error> }
  ]
}

​
Example: delete multiple agents

Request
curl -X POST \
  https://api.livechatinc.com/v3.6/configuration/action/batch_delete_agents \
  -H 'Authorization: Basic <your_personal_access_token>' \
  -H 'Content-Type: application/json' \
  -d '{
        "requests": [
          { "id": "smith@example.com" },
          { "id": "brown@example.com" },
          {}
        ]
      }'
Response
{
  "responses": [
    {},
    {},
    {
      "error": {
        "type": "validation",
        "message": "`id` is required"
      }
    }
  ]
}
Errors are returned inline — a failure on one item doesn’t affect the others.

​
Supported methods

​
Agents

MethodBatch URL
Create agenthttps://api.livechatinc.com/v3.6/configuration/action/batch_create_agents
Update agenthttps://api.livechatinc.com/v3.6/configuration/action/batch_update_agents
Delete agenthttps://api.livechatinc.com/v3.6/configuration/action/batch_delete_agents
Suspend agenthttps://api.livechatinc.com/v3.6/configuration/action/batch_suspend_agents
Unsuspend agenthttps://api.livechatinc.com/v3.6/configuration/action/batch_unsuspend_agents
Approve agenthttps://api.livechatinc.com/v3.6/configuration/action/batch_approve_agents

​
Bots

MethodBatch URL
Create bothttps://api.livechatinc.com/v3.6/configuration/action/batch_create_bots
Update bothttps://api.livechatinc.com/v3.6/configuration/action/batch_update_bots
Delete bothttps://api.livechatinc.com/v3.6/configuration/action/batch_delete_bots