Send Assessment Invite

post

https://api.getknit.dev/v1.0/assessment.send.invite

This API's purpose is to dispatch assessment invitations to candidates.

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Body Params

startDateTime

string

required

UTC time indicating the earliest time to begin the Assessment. eg. 2020-01-01T15:00:00Z (ISO format)

endDateTime

string

required

UTC time representing the final deadline for taking the Assessment. eg. 2020-01-01T15:00:00Z (ISO format)

assessmentId

string

required

The Assessment ID obtained from the "/assessment.get.types" API as specified in the documentation (https://developers.getknit.dev/reference/get-assessments)

firstName

string

required

First name of the applicant

emailId

string

required

Email address of the applicant

applicantId

string

Unique identifier assigned to the applicant

lastName

string

Last name of the applicant

phoneNumber

string

Phone number of the applicant

sendEmail

boolean

Defaults to false

Email address of the candidate to whom the assessment email will be sent. (applicable only if vendor provides option)

metaData

string

JSON-formatted string containing set of key-value attributes to provide additional data

Responses

Language

Credentials

Loading…

Response

Click Try It! to start a request and see the response here! Or choose an example:

application/json

200200

400400