Skip to main content
PATCH
/
api
/
public
/
candidates
/
{candidateId}
/
status
Update candidate status
curl --request PATCH \
  --url https://api.ropes.ai/api/public/candidates/{candidateId}/status \
  --header 'Content-Type: application/json' \
  --header 'x-api-key: <api-key>' \
  --data '{}'
{
  "success": true,
  "updated": true
}

Authorizations

​
x-api-key
string
header
required

Path Parameters

​
candidateId
string
required

The unique identifier of the candidate

Body

application/json
​
status
enum<string>
required

New status for the candidate

Available options:
Not Assigned,
Assigned,
Expired,
Completed,
Passed,
Failed,
Error

Response

Successfully updated candidate status

​
success
boolean
required

Whether the operation was successful

​
updated
boolean
required

Whether the candidate status was updated