# Invite Candidate

POST $BASE_URL/portal/invite

# Request Payload

Field	Type	Description
`Authorization`	String	Authorization token from PerspectAI platform

Field	Type	Description
`start_date`	String	Assessment Start date; Timestamp Format is yyyy-MM-dd HH:mm:ssZZZZ
`end_date`	String	Assessment End date; Timestamp Format is yyyy-MM-dd HH:mm:ssZZZZ
`key_series_no`	String	Assessment Serial number
`mail_list`	List[Object]	Invitee Details
`mail_list.name`	String	Invitee Name
`mail_list.emailId`	String	Invitee Email ID
`mail_list.mobile`	String	Invitee Mobile Number
`mail_list.location`	String	Invitee Location
`mail_list.gender`	String	Invitee Gender
`mail_list.dob`	String	Invitee Date of Birth

{
  "start_date": "2023-06-04 00:49:42+0530",
  "end_date": "2023-06-11 10:00:42+0530",
  "key_series_no": "850",
  "mail_list": [
    {
      "name": "Subham",
      "emailId": "subham+41@perspect.ai",
      "mobile": "8729099039",
      "gender": "Male",
      "dob": "1992-12-20",
      "bu": null,
      "dept": null,
      "job_post_date": null,
      "job_title": null,
      "location": "India",
      "sub_dept": null
    }
  ]
}

# Response Payload

Field	Type	Description
`message`	String	Message
`existing_emails`	List[Object]	Invitees Details
`existing_emails.name`	String	Invitee name
`existing_emails.status`	String	Invitee Status
`existing_emails.id`	String	Invitee invite_id
`existing_emails.license_key`	String	Invitee License key
`existing_emails.megic_link`	String	Invitee Magic Link

200 OK
{
  "message": "Success",
  "existing_emails": [
    {
      "name": "Subham",
      "status": "Invited",
      "id": "25d9b3b7-0729-4a2c-95fd-c6ecb2b94851",
      "license_key": "YDJTPM",
      "android_url": "https://play.google.com/store/apps/details?id=com.loopreality.perspectai",
      "ios_url": "https://apps.apple.com/in/app/perspectai/id1449024326",
      "web_url": "https://app.perspect.ai",
      "megic_link": "https://tic.perspect.ai/invite-verify/25d9b3b7-0729-4a2c-95fd-c6ecb2b94851"
    }
  ]
}

500 Internal Server Error
{
    "message":"Something went wrong"
}

candidate