Update Custom Values🔗︎

HTTP Verb	Path
PATCH	/v9/index/(indexId)/documents/(documentId)

Updates the custom value ids for a document.

Info

You can try this endpoint out at our Swagger page ( US Data Center | EU Data Center | AU Data Center )

Parameter	Data Type	Description
indexId	string	The id for the index that contains the document (case-insensitive).
documentId	string	The id of the document to update (case-insensitive).

Request Body🔗︎

CustomValues 🔗︎ string[] required

The custom value ids to add/remove/overwrite in the document.

Method 🔗︎ string required

One of: "Delete", "Add", "Overwrite"

Sample JSON

{
  "CustomValues": [
    ""
  ],
  "Method": ""
}

Info 🔗︎ object

Information explaining the outcome of the transaction.

Info properties

Code 🔗︎ string

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

This message further describes the code providing additional detail.

Value 🔗︎ object

An empty object.

Sample JSON

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