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

Name	Type	Required	Description
`requests[]`	Array	Yes
`requests[].action`	String	Yes	Which indexing operation to perform: `addObject`: adds records to an index. Equivalent to the "Add a new record (with auto-generated object ID)" operation. `updateObject`: adds or replaces records in an index. Equivalent to the "Add or replace a record" operation. `partialUpdateObject`: adds or updates attributes within records. Equivalent to the "Add or update attributes" operation with the `createIfNoExists` parameter set to true. (If a record with the specified `objectID` doesn't exist in the specified index, this action creates adds the record to the index) `partialUpdateObjectNoCreate`: same as `partialUpdateObject`, but with `createIfNoExists` set to false. (A record isn't added to the index if its `objectID` doesn't exist) `deleteObject`: delete records from an index. Equivalent to the "Delete a record" operation. `delete`. Delete an index. Equivalent to the "Delete an index" operation. `clear`: delete all records from an index. Equivalent to the "Delete all records from an index operation". Valid values: `"clear"` `"addObject"` `"partialUpdateObjectNoCreate"` `"deleteObject"` `"updateObject"` `"partialUpdateObject"` `"delete"`
`requests[].body`	Object	Yes	Operation arguments (varies with specified `action`).

requests[].action

String

Yes

Which indexing operation to perform:

addObject: adds records to an index. Equivalent to the "Add a new record (with auto-generated object ID)" operation.
updateObject: adds or replaces records in an index. Equivalent to the "Add or replace a record" operation.
partialUpdateObject: adds or updates attributes within records. Equivalent to the "Add or update attributes" operation with the createIfNoExists parameter set to true. (If a record with the specified objectID doesn't exist in the specified index, this action creates adds the record to the index)
partialUpdateObjectNoCreate: same as partialUpdateObject, but with createIfNoExists set to false. (A record isn't added to the index if its objectID doesn't exist)
deleteObject: delete records from an index. Equivalent to the "Delete a record" operation.
delete. Delete an index. Equivalent to the "Delete an index" operation.
clear: delete all records from an index. Equivalent to the "Delete all records from an index operation".

Valid values:

"clear"
"addObject"
"partialUpdateObjectNoCreate"
"deleteObject"
"updateObject"
"partialUpdateObject"
"delete"

requests[].body

Object

Yes

Operation arguments (varies with specified action).

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.

All third party trademarks (including logos and icons) are the property of their respective owners, which do not sponsor, authorize, or endorse this website.

Pricing Templates Integrations Blog Contact Us Help

Terms of Service Privacy Policy