Candidate Custom Fields

An endpoint that provides the ability to add custom key-value pair (dictionary) fields to a candidate

Headers:
Authorization : {token}
Content-Type : application/json

Result codes

403 Forbidden
200 Ok (Updated)
201 Created (Created)
400 Bad request
500 Internal server error

POST json data

Field

Type

Description

Key (required)

string

The key for the custom field. The key can not be duplicated per candidate

Value (required)

string

The value associated with the key.

Type (optional)

string

Predefined type. Currently the supported types are: Text, Link, Image.

Id (required for updates)

int

The id for the custom field being updated.

Example of a create post data

{    
    "key": "CandidatePortfolio",
    "Value": "https://johnsmith.com"
    "Type": "Link",
}

Example of an update post data

{   
		id: 1,
    "key": "CandidatePortfolio",
    "Value": "https://johnsmith.com/portfolio",
    "Type": "Link",
}

Returns a list of custom fields associated with a candidate

Headers:
Authorization : {token}

Result codes

403 Forbidden
200 OK
400 Bad request
500 Internal server error

Response

Calling this endpoint will return a Js array containing the custom fields for a candidate

[
    {
        "Id": 1,
        "CandidateId": 12345,        
        "Key": "CandidatePortfolio",
        "Value": "https://johnsmith.com/portfolio",
        "CreatedDate": "1998-02-30T17:06:59.083"
    }
  ]