Update Candidate

curl --request PUT \
  --url https://api.harmonyforstaffing.com/api/candidates/456 \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '{
    "firstName": "John",
    "lastName": "Doe",
    "email": "john.doe@example.com",
    "phone": "+1-555-555-5555",
    "address": {
      "address1": "123 Main St",
      "city": "San Francisco",
      "state": "CA",
      "zip": "94105",
      "countryCode": "US"
    },
    "notes": "Excellent communication skills, available immediately",
    "profession": "Software Engineer",
    "specialty": "Frontend Development",
    "status": "ACTIVE"
  }'

{
  "id": 456,
  "firstName": "John",
  "lastName": "Doe",
  "email": "john.doe@example.com",
  "phone": "+1-555-555-5555",
  "address": {
    "address1": "123 Main St",
    "city": "San Francisco",
    "state": "CA",
    "zip": "94105",
    "countryCode": "US"
  },
  "notes": "Excellent communication skills, available immediately",
  "profession": "Software Engineer",
  "specialty": "Frontend Development",
  "status": "ACTIVE",
  "dateAdded": 1679253000
}

PUT

api

candidates

{id}

curl --request PUT \
  --url https://api.harmonyforstaffing.com/api/candidates/456 \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '{
    "firstName": "John",
    "lastName": "Doe",
    "email": "john.doe@example.com",
    "phone": "+1-555-555-5555",
    "address": {
      "address1": "123 Main St",
      "city": "San Francisco",
      "state": "CA",
      "zip": "94105",
      "countryCode": "US"
    },
    "notes": "Excellent communication skills, available immediately",
    "profession": "Software Engineer",
    "specialty": "Frontend Development",
    "status": "ACTIVE"
  }'

{
  "id": 456,
  "firstName": "John",
  "lastName": "Doe",
  "email": "john.doe@example.com",
  "phone": "+1-555-555-5555",
  "address": {
    "address1": "123 Main St",
    "city": "San Francisco",
    "state": "CA",
    "zip": "94105",
    "countryCode": "US"
  },
  "notes": "Excellent communication skills, available immediately",
  "profession": "Software Engineer",
  "specialty": "Frontend Development",
  "status": "ACTIVE",
  "dateAdded": 1679253000
}

Update the details of an existing candidate.

Path Parameters

number

required

ID of the candidate to update

Body Parameters

string

Updated first name

string

Updated last name

string

Updated email address

string

Updated contact phone number

object

Updated address information

Show Address fields

string

Street address line 1

string

Street address line 2

string

City

string

State

string

ZIP/Postal code

string

Country code

string

Timezone

string

Additional notes about the candidate

string

Candidate’s primary profession

string

Candidate’s specialty or focus area

string

Current status of the candidate

Response

number

The ID of the updated candidate

string

First name

string

Last name

string

Email address

string

Phone number

object

Address information

string

Additional notes

string

Primary profession

string

Specialty or focus area

string

Current status

integer

Unix timestamp when the candidate was added

curl --request PUT \
  --url https://api.harmonyforstaffing.com/api/candidates/456 \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '{
    "firstName": "John",
    "lastName": "Doe",
    "email": "john.doe@example.com",
    "phone": "+1-555-555-5555",
    "address": {
      "address1": "123 Main St",
      "city": "San Francisco",
      "state": "CA",
      "zip": "94105",
      "countryCode": "US"
    },
    "notes": "Excellent communication skills, available immediately",
    "profession": "Software Engineer",
    "specialty": "Frontend Development",
    "status": "ACTIVE"
  }'

{
  "id": 456,
  "firstName": "John",
  "lastName": "Doe",
  "email": "john.doe@example.com",
  "phone": "+1-555-555-5555",
  "address": {
    "address1": "123 Main St",
    "city": "San Francisco",
    "state": "CA",
    "zip": "94105",
    "countryCode": "US"
  },
  "notes": "Excellent communication skills, available immediately",
  "profession": "Software Engineer",
  "specialty": "Frontend Development",
  "status": "ACTIVE",
  "dateAdded": 1679253000
}

Getting Started

API Reference

Path Parameters

Body Parameters

Response

​Path Parameters

​Body Parameters

​Response

Path Parameters

Body Parameters

Response