Applicants

Create an Applicant

This section describes all endpoints related to applicants. It will enable you to create and manage applicant objects.

post/v2/applicants

Request

Request body

external_applicant_idstring
external_applicant_namestring
emailstring email

Example request

{
  "external_applicant_id": "ext_osdfdfdb4hryu5cei5vwoabrk5k",
  "external_applicant_name": "David Vincent",
  "email": "david.vincent@courriel.ml"
}

Response

Applicant successfully created

idstring

Applicant unique identifier.

created_onstring date-time required

UTC Date time when the resource was created

modified_onstring date-time required

UTC Date time when the resource was modified

external_applicant_idstring
external_applicant_namestring
emailstring email

Example response

{
  "id": "aplt_tkoi5db4hryu5cei5vwoabr7we",
  "created_on": "2017-07-21T17:32:28Z",
  "modified_on": "2017-07-21T17:40:32Z",
  "external_applicant_id": "ext_osdfdfdb4hryu5cei5vwoabrk5k",
  "external_applicant_name": "David Vincent",
  "email": "david.vincent@courriel.ml"
}

Changes

No recorded changes to this operation across all 1 revision of this API.