Create an Index

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

Creates an index.

Info

• 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.

Request Body

IndexType 🔗︎ string required

IndexType

The type of the index. One of:

• Resume
• Job

Sample JSON

{
  "IndexType": ""
}

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

Message 🔗︎ string

Message

This message further describes the code providing additional detail.

Value 🔗︎ object

Value

An empty object.

Sample JSON

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