CandidateCreate

Request body for creating or updating a candidate

HCMHuman ResourcesRecruitingSaaSTalent Acquisition

Properties

Name	Type	Description
firstName	string	Candidate first name
lastName	string	Candidate last name
email	string	Primary email address
phone	string	Primary phone number
address	object	Candidate mailing address
source	object	A reference to a related Workday resource

View JSON Schema on GitHub

JSON Schema

{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "title": "CandidateCreate",
  "description": "Request body for creating or updating a candidate",
  "$id": "https://raw.githubusercontent.com/api-evangelist/workday-recruiting/refs/heads/main/json-schema/recruiting-rest-api-candidate-create-schema.json",
  "type": "object",
  "properties": {
    "firstName": {
      "type": "string",
      "description": "Candidate first name",
      "example": "Jordan"
    },
    "lastName": {
      "type": "string",
      "description": "Candidate last name",
      "example": "Reyes"
    },
    "email": {
      "type": "string",
      "format": "email",
      "description": "Primary email address",
      "example": "[email protected]"
    },
    "phone": {
      "type": "string",
      "description": "Primary phone number",
      "example": "+1-415-555-0123"
    },
    "address": {
      "type": "object",
      "properties": {
        "addressLine1": {
          "type": "string",
          "example": "123 Market Street"
        },
        "addressLine2": {
          "type": "string",
          "example": "123 Market Street"
        },
        "city": {
          "type": "string",
          "example": "San Francisco"
        },
        "stateProvince": {
          "type": "string",
          "example": "CA"
        },
        "postalCode": {
          "type": "string",
          "example": "94105"
        },
        "country": {
          "type": "object",
          "description": "A reference to a related Workday resource",
          "properties": {
            "id": {
              "type": "string",
              "description": "Workday ID (WID) of the referenced resource",
              "example": "11111111-2222-3333-4444-555555555555"
            },
            "descriptor": {
              "type": "string",
              "description": "Display name of the referenced resource",
              "example": "Senior Software Engineer"
            }
          }
        }
      },
      "description": "Candidate mailing address"
    },
    "source": {
      "type": "object",
      "description": "A reference to a related Workday resource",
      "properties": {
        "id": {
          "type": "string",
          "description": "Workday ID (WID) of the referenced resource",
          "example": "11111111-2222-3333-4444-555555555555"
        },
        "descriptor": {
          "type": "string",
          "description": "Display name of the referenced resource",
          "example": "Senior Software Engineer"
        }
      }
    }
  },
  "required": [
    "firstName",
    "lastName",
    "email"
  ]
}