Request Body
IndexTyperequiredstring
The type of the index. One of:
- Resume
- Job
API Technical Specs
Learn how to configure and leverage our services to achieve your toughest recruiting needs.
Create an Index
POST /v9/index/(indexId)
Creates an index.
Notes
- You can try this endpoint out at our Swagger page ( US Data Center | EU Data Center | AU Data Center)
Path Parameters
| Parameter | Data Type | Description |
|---|---|---|
| indexId | string | The id to assign to the new index. This is restricted to alphanumeric with dashes and underscores. All values will be converted to lower-case. If using sub-accounts, this value must be unique across all sub-accounts. |
Sample Request
{ ...
"IndexType" : ""}
"IndexType" : ""}
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
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
Info.Messagestring
This message further describes the code providing additional detail.
Valueobject
An empty object.
Sample Response
{ ...
{ ...
"Code" : "","Message" : ""},{ ...
}}
{ ...
"Code" : "","Message" : ""},{ ...
}}