POST /1/indexes/{indexName}/batch
Adds, updates, or deletes records in one index with a single API request.
Batching index updates reduces latency and increases data integrity.
- Actions are applied in the order they're specified.
- Actions are equivalent to the individual API requests of the same name.
This operation is subject to indexing rate limits.
Servers
- https://{appId}.algolia.net
- https://{appId}-1.algolianet.com
- https://{appId}-2.algolianet.com
- https://{appId}-3.algolianet.com
- https://{appId}-dsn.algolia.net
Path parameters
| Name | Type | Required | Description |
|---|---|---|---|
indexName |
String | Yes |
Name of the index on which to perform the operation. |
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:
|
requests[].body |
Object | Yes |
Operation arguments (varies with specified |
How to start integrating
- Add HTTP Task to your workflow definition.
- 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.
- Click Test request to test run your request to the API and see the API's response.