POST /deleteObjects

Helper: Deletes every records for the given objectIDs. The chunkedBatch helper splits this into batch requests with at most 1,000 objectIDs each.

Servers

Query parameters

Name Type Required Description
waitForTasks Boolean No

Whether to wait until every batch task has been processed. This may take longer but is more reliable.

requestOptions Object No

The request options to pass to the batch method.

objectIDs[] Array Yes

The objectIDs to delete.

batchSize Integer No

The size of the chunk of objects. The number of batch calls will be equal to length(objects) / batchSize. Defaults to 1,000.

indexName String Yes

The indexName to delete objectIDs from.

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.