Skip to main content
POST
/
api
/
public
/
candidates
/
new
Create candidate
curl --request POST \
  --url https://api.ropes.ai/api/public/candidates/new \
  --header 'Content-Type: application/json' \
  --header 'x-api-key: <api-key>' \
  --data '
{
  "name": "<string>",
  "email": "jsmith@example.com",
  "integrationSource": "<string>",
  "externalId": "<string>"
}
'
{
  "success": true,
  "identifier": "<string>"
}

Authorizations

​
x-api-key
string
header
required

Body

application/json
​
name
string
required

The full name of the candidate

Minimum string length: 1
​
email
string<email>
required

The email address of the candidate

​
integrationSource
string

Integration source. Must be provided with externalId.

​
externalId
string

External ID from the integration source. Must be provided with integrationSource.

Minimum string length: 1

Response

Successfully created candidate

​
success
boolean
required

Whether the operation was successful

​
identifier
string
required

Unique identifier for the newly created candidate