Skip to main content
DELETE
/
api
/
public
/
candidates
/
{candidateId}
Delete candidate
curl --request DELETE \
  --url https://api.ropes.ai/api/public/candidates/{candidateId} \
  --header 'x-api-key: <api-key>'
{
  "success": true,
  "message": "<string>"
}

Documentation Index

Fetch the complete documentation index at: https://docs.ropes.ai/llms.txt

Use this file to discover all available pages before exploring further.

Authorizations

​
x-api-key
string
header
required

Path Parameters

​
candidateId
string
required

The unique identifier of the candidate to delete

Response

Successfully deleted candidate

​
success
boolean
required

Whether the operation was successful

​
message
string
required

Success or error message