/custom_fields/candidates/:id/fields

Allows to add profile fields to a candidate with provided ID.

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…

Profile fields types

Specify the input type of profile field you want to add to the candidate profile in the kind field. Below you can find example payloads for different profile fields types:

{
    "field": {
        "name": "Example single-line field",
        "values": [
            {
                "text": "Example value"
            }
        ],
        "kind": "single_line"
    }
}
{
    "field": {
        "name": "Example multi-line field",
        "values": [
            {
                "text": "Example value 1"
            },
            {
                "text": "Example value 2"
            }
        ],
        "kind": "multi_line"
    }
}
{
    "field": {
        "name": "Example Yes/No field",
        "values": [
            {
                "flag": true
            }
        ],
        "kind": "boolean"
    }
}
{
    "field": {
        "values": [
            {
                "text": "Keizersgracht 313, 1016 EE Amsterdam, Netherlands"
            }
        ],
        "kind": "address"
    }
}
{
    "field": {
        "values": [
            {
                "value": "female"
            }
        ],
        "kind": "gender"
    }
}
{
  "field": {
    "name": "Example number field",
    "values": [
      {
        "number": "12345"
      }
    ],
    "kind": "number"
  }
}
{
    "field": {
        "values": [
            {
                "country_code": "NL"
            }
        ],
        "kind": "nationality"
    }
}
{
    "field": {
        "values": [
            {
                "language_code": "en",
                "level": "advanced"
            },
            {
                "language_code": "nl",
                "level": "native"
            }
        ],
        "kind": "language_skill"
    }
}
{
    "field": {
        "values": [
            {
                "text": "SQL"
            },
            {
                "text": "HTML"
            },
            {
                "text": "CSS"
            }
        ],
        "kind": "skills"
    }
}
{
  "field": {
    "fixed": true,
    "id": null,
    "kind": "salary",
    "name": "Example salary field",
    "origin": "manual",
    "values": [
      {
        "amount": "5000",
        "currency": "EUR"
      }
    ],
    "visible": true
  }
}
{
    "field": {
        "values": [
            {
                "date": "1990-01-01"
            }
        ],
        "kind": "date_of_birth"
    }
}
{
  "field": {
    "name": "Example date field",
    "values": [
      {
        "date": "YYYY-MM-DD"
      }
    ],
    "kind": "date"
  }
}
{
  "field": {
    "kind": "experience",
    "values": [
      {
        "title": "Experience title",
        "company": "Company name ",
        "location": "Location",
        "description": "Description",
        "startDate": "YYYY-MM-DD",
        "endDate": "YYYY-MM-DD"
      }
    ]
  }
}
{
  "field": {
    "kind": "education",
    "values": [
      {
        "school": "School name",
        "degree": "Degree name",
        "description": "Description",
        "major": "Course type",
        "startDate": "YYYY-MM-DD",
        "endDate": "YYYY-MM-DD"
      }
    ]
  }
}
Path Params
string
required

Company ID

string
required

Candidate ID

Body Params
field
object
Responses

Language
Credentials
OAuth2
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json