Apply

Submitting a candidate application

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

Result codes

403 Forbidden
201 Application successfully submitted
400 Bad request
500 Internal server error.

POST JSON data

Wrap Candidate fields for list of fields under CandidateInfo property

{
    CandidateInfo: { Candidate fields },
    CustomQuestionsAnswers: [ ],
    QuestionnaireAnswers: [ ],
    CandidateUtmSource:"{candidate source}"
    ApplicationNotes:"{application notes}"
}

Candidate Source

Field

Type

Description

CandidateInfo

Object (required)

Candidate Information. See Candidate Properties Table

CustomQuestionsAnswers

Array of Custom Questions Answers objects (optional)

Answers for vacancy custom questions.
See Question Answer Table bellow for supported formats

QuestionnaireAnswers

Array of Question Answer objects (optional)

Answers for questionnaires.
See Question Answer Table bellow for supported formats

CandidateUtmSource

String (optional)

Source of the candidate such as the "Integration Partner Name"

ApplicationNotes

String (optional)

Candidate application notes

Question Answers

Field

Type

Description

QuestionId

int (required)

Question Id as per application question Id

Answer

string

Answers for questions of type Text or Paragraph.
Used for Question Type 1 and 4

SelectedOptionId

nullable int

Radio-Button selected Option Id.
Used for Question Type 2

SelectedOptionIds

Array of int objects

Checkbox selected Options Ids.
Used for Question Type 3

Sample POST

{
    "CandidateInfo": {
        "FirstName": "Jane",
        "LastName": "Smith",
        "Title": null,
        "CoverNote": null,
        "Summary": "Jane is a Architect at a Global Software company.",
        "ProfileImageUrl": null,
        "CandidateSource": 1,
        "SocialTwitter": null,
        "SocialFacebook": null,
        "SocialLinkedIn": null,
        "SocialGooglePlus": null,
        "Email": "[email protected]",
        "Phone": "0871234567",
        "CreatedById": 6,
        "UpdatedById": null,
        "VacancyId": 9999,
        "StageId": null,
        "CityId": null,
        "CityName": null,
        "CountryId": 1,
        "EthnicityId": 4,
        "ExternalRecruiterId": null,
        "Headline": null,
        "GenderId": 2,
        "Disability": null,
        "NationalityId": null,
    },
    "WorkHistories": [{
        "From": "2017-01-01T00:00:00",
        "To": "2017-10-31T00:00:00",
        "Title": "Architect",
        "Company": "Microsoft",
        "Summary": "Duties include translate business requirements into technical specifications and developing enterprise systems."
    }],
    "Educations": [{
        "From": "2017-01-01T00:00:00",
        "To": "2017-12-31T00:00:00",
        "Title": "MTech: Information Technology",
        "Field": null,
        "School": "Unisa",
        "Summary": null
    }],
    "Skills": [{
            "Name": "SQL"
        },
        {
            "Name": "ASP.NET"
        }
    ],
    "CustomQuestionsAnswers": [{
            "QuestionId": 100,
            "Answer": "I have the ability to learn from previous mistakes and have great task prioritization as well determination."
        },
        {
            "QuestionId": 101,
            "SelectedOptionId": 3
        },  
        {
            "QuestionId": 102,
            "SelectedOptionIds": [1,2,5]
        }
    ],
    "QuestionnaireAnswers": [{
        		"QuestionId": 55,
        		"Answer": "I have no issues working long hours on my own to ensure that I achieve more sales."
        },{
            "QuestionId": 56,
            "SelectedOptionId": 295
        },  
        {
            "QuestionId": 57,
            "SelectedOptionIds": [301,302,305]
        }],
      "ApplicationNotes": "I look forward to discussing the Cloud Architect role and my qualifications with you in more detail.",
        "CandidateUtmSource": "Awesome-Parnter-Name"
}

📘

Response header on application submission

When an application is successfully created the HTTP response will have the location in the header with the url of how to retrieve the candidate with the created id