Command Palette

Search for a command to run...

Log In
Get help

Update a Candidate

put/public/v1/candidates/{candidate}

Only the fields sent are changed.

Authorization

  • Authorizationstringrequired

    Bearer authentication header of the form Bearer <token>, where <token> is your API key. See How to set up an API key.

Path parameters

  • candidatestringrequired

    The candidate UUID

Body

application/json
  • first_namestringmax length 255
  • middle_namestring | nullmax length 255
  • last_namestringmax length 255
  • preferred_namestring | nullmax length 255
  • emailstring<email>max length 255
  • mobilestring | nullmax length 255
  • phonestring | nullmax length 255

Response

200application/json

CandidateResource

  • dataobjectrequired
    ▶Show 10 child attributes
    • idstringrequired
      Example:f6a7b8c9-d0e1-42f3-8a4b-5c6d7e8f9a0b
    • first_namestringrequired
      Example:Ava
    • middle_namestring | nullrequired
      Example:Mai
    • last_namestringrequired
      Example:Nguyen
    • preferred_namestring | nullrequired
      Example:Avie
    • emailstringrequired
      Example:ava.nguyen@example.com
    • mobilestring | nullrequired
      Example:0412 345 678
    • phonestring | nullrequired
      Example:02 9876 5432
    • created_atstringrequired
      Example:2026-03-01T10:30:00+11:00
    • updated_atstringrequired
      Example:2026-03-02T09:00:00+11:00

Errors

  • 401Unauthenticated
  • 403Authorization error
  • 404Not found
  • 422Validation error