Skip to main content

Create a new candidate.

POST 

/:customerId/candidates

Create a new candidate.

Request

Path Parameters

    customerId uuidrequired

    A unique UUID value that identifies the customer.

Header Parameters

    X-MindKey-User-Language string

    Default value: en-us

    Specify User UI Language

    X-MindKey-User-Culture string

    Default value: en-us

    Specify User UI Culture

    X-MindKey-User-Timezone string

    Default value: Europe/Copenhagen

    Specify timezone.

Body

    Candidate

    object

    See CandidateUploadModel model.

    vacancyId stringrequired

    Possible values: <= 10 characters

    name stringrequired

    Possible values: <= 150 characters

    email emailrequired

    Possible values: non-empty

    previouslyApplied booleanrequired
    allowSave booleanrequired
    nationalityId stringnullable
    addressStreet1 stringnullable
    addressStreet2 stringnullable
    addressCity stringnullable
    addressStateProvince stringnullable
    addressZipPostalCode stringnullable
    addressCountryRegion stringnullable
    homePhone stringnullable
    mobilePhone stringnullable
    birthDate date-timenullable
    advertisementReference stringnullable
    gender EnumGender (string)

    Possible values: [NotSpecified, Male, Female, Other]

    salutation EnumSalutation (string)

    Possible values: [None, Dr, Miss, Mr, Mrs, Ms]

    maritalStatus EnumMaritalStatus (string)

    Possible values: [NotSpecified, Single, Married, Divorced, Widowed, Cohabit]

    candidateMailingTemplateId stringnullable
    locations string[]nullable
    regions string[]nullable
    fieldsOfWork string[]nullable
    vacancyElementLines string[]nullable

    note

    object

    documentType stringnullable
    text stringnullable

    attachmentDetails

    object[]

    nullable

  • Array [

  • documentTypeId stringnullable
    description stringnullable
  • ]

  • Attachments binary[]

    Array of FormFile

    Image binary

    FormFile

Responses

Created

Schema

    boolean

Loading...