TAtalkjs
Batch operations

Perform batch operations

Performs multiple operations in a batch with a single request. You can include a maximum of 10 operations in a single batch request. For batch requests, the REST API rate limits support 500 burst requests, a maximum of 100 requests in the queue, and 1 batch request per second.

Request

The payload must be an array of operations. Each operation must have the following format:

[sequence_number, method, path, payload, options]

You can include any TalkJS REST API operation in a batch operation, as long as its request has JSON content, or is empty.

You can't upload files as part of a batch operation, because file uploads require multipart/form-data-formatted data. To upload a file, use the 'Upload file' resource instead.

Response

The response is an array of operation responses. Each operation response has the format:

[sequence_number, http_status_code, operation_response]

post/v1/{appId}/batch

Request

Path parameters

appIdstring required
Example:abcd1234

A unique identifier of your TalkJS app. You can find your app ID on the Settings page of your dashboard.

Request body

Example request

[
  {
    "sequence_number": 1,
    "method": "GET",
    "path": "/users/alice",
    "payload": {
      "name": "Alice"
    },
    "options": {
      "api_version": "2021-01-01T00:00:00.000Z"
    }
  }
]

Response

Batch operation performed successfully.

Example response

[
  {
    "sequence_number": 1,
    "http_status_code": 200
  }
]

Changes

No recorded changes to this operation across all 1 revision of this API.