Skip to main

API Technical Specs

Learn how to configure and leverage our services to achieve your toughest recruiting needs.
SaaS     |

Update Custom Values

PATCH /v9/index/(indexId)/documents/(documentId)

Updates the custom value ids for a document.

Notes

Path Parameters

ParameterData TypeDescription
indexIdstringThe id for the index that contains the document (case-insensitive).
documentIdstringThe id of the document to update (case-insensitive).

Request Body

CustomValuesrequiredstring[]
The custom value ids to add/remove/overwrite in the document.
Methodrequiredstring
One of: "Delete", "Add", "Overwrite"

Sample Request

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

Response Body

Infoobject
Information explaining the outcome of the transaction.
Info.Codestring
A response code elaborating on the HTTP status code.
The following is a list of codes that can be returned by the service:

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
Info.Messagestring
This message further describes the code providing additional detail.
Valueobject
An empty object.

Sample Response

{ ... 
{ ... 
"Code" :  "","Message" :  ""
},
{ ... 
}
}