Update ATS Candidate

PATCH

/ats/candidates/:candidate_id

PATCH

/rest/ats/candidates/:candidate_id

curl -X PATCH https://api.letsdeel.com/rest/ats/candidates/a1b2c3d4-e5f6-7890-1234-567890abcdef \
     -H "Authorization: Bearer <token>" \
     -H "Content-Type: application/json" \
     -d '{
  "data": {}
}'

{
  "data": {
    "id": "a1b2c3d4-e5f6-7890-1234-567890abcdef",
    "email": "john.doe@example.com",
    "last_name": "Doe",
    "created_at": "2024-01-01T00:00:00Z",
    "first_name": "John",
    "numeric_id": 123,
    "updated_at": "2024-01-01T00:00:00Z",
    "city": "Berlin",
    "source": "LINKEDIN",
    "pic_url": "https://example.com/pic.jpg",
    "imported_id": "ext-123",
    "country_code": "DE",
    "phone_number": "+1234567890",
    "anonymized_at": "2024-01-01T00:00:00Z",
    "import_session_id": "session-123",
    "origin_source_slug": "sourced_internally",
    "final_archivation_at": "2024-01-01T00:00:00Z",
    "linkedin_profile_url": "https://linkedin.com/in/johndoe"
  }
}

Updates an existing candidate and leaves any detail that is not sent unchanged. Use it to keep a candidate’s profile current or to correct how they were sourced, for example to mark them as sourced internally.

Token scopes: ats:write, worker:write

Authentication

AuthorizationBearer

Authentication

The Deel API uses bearer tokens to authenticate requests. All API calls must be made over HTTPS — calls over plain HTTP or without authentication will fail.

curl -X GET 'https://api.deel.training/rest/v2/contracts' \
  -H 'Authorization: Bearer YOUR-TOKEN-HERE'

Learn more about authentication

AuthorizationBearer

Standard OAuth2 security scheme based on https://swagger.io/docs/specification/authentication/

Path parameters

candidate_idstringRequiredformat: "uuid"

Unique identifier of the candidate to update

Request

Update candidate request. At least one field must be provided.

dataobjectRequired

Response

Successful response with the updated candidate data

dataobject

Errors

400

Bad Request Error

401

Unauthorized Error

403

Forbidden Error

404

Not Found Error

409

Conflict Error

500

Internal Server Error