Skip to content
Tx Platform
Delete Multiple Documents

Delete Multiple Documents🔗︎

HTTP Verb Path
POST /v9/index/(indexId)/documents/delete

Delete multiple documents from an index.

Info

Path Parameters🔗︎

Parameter Data Type Description
indexId string The id for the index that contains the documents (case-insensitive).

Request Body🔗︎

Body 🔗︎ string[] required

Body🔗︎

Each item in the array is the id of a document to delete from the index (case-insensitive).

Sample JSON
[
  ""
]

Response Body🔗︎

Info 🔗︎ object

Info🔗︎

Information explaining the outcome of the transaction.


Info properties

Code 🔗︎ string

Code🔗︎

Code Description
Success Successful transaction
MissingParameter A required parameter wasn't provided
InvalidParameter A parameter was incorrectly specified
AuthenticationError An error occurred with the credentials provided
Unauthorized Your account doesn't have permission to perform this operation
DataNotFound Data with the specified name wasn't found
Message 🔗︎ string

Message🔗︎

This message further describes the code providing additional detail.

Value 🔗︎ object

Value🔗︎

An empty object.

Sample JSON
{
  "Info": {
    "Code": "",
    "Message": ""
  },
  "Value": {}
}