POST /1/indexes/*/batch

Adds, updates, or deletes records in multiple indices with a single API request.

This operation is subject to indexing rate limits.

Servers

Request headers

Name Type Required Description
Content-Type String Yes The media type of the request body.

Default value: "application/json"

Request body fields

Name Type Required Description
requests[] Array Yes
requests[].action String Yes

Type of indexing operation.

Possible values:

  • "clear"
  • "addObject"
  • "partialUpdateObjectNoCreate"
  • "deleteObject"
  • "updateObject"
  • "partialUpdateObject"
  • "delete"
requests[].body Object No

Operation arguments (varies with specified action).

requests[].indexName String Yes

Index name (case-sensitive).

How to start integrating

  1. Add HTTP Task to your workflow definition.
  2. Search for the API you want to integrate with and click on the name.
    • This loads the API reference documentation and prepares the Http request settings.
  3. Click Test request to test run your request to the API and see the API's response.