Invite Applicant
Allows you to search for active applicants by phone number. Formatting of the phone number doesn't matter, and the number can be partial.
A simplified profile is returned so you're able to determine if you've found the applicant you're looking for. Complete details on the applicant can be returned with a GET request for the Applicant Details.
Request
Requires Authorization
POST: https://sandbox.approveowl.com/api/v1/applicant_invites/
Required Parameters:
| Parameter | Type | Description |
|---|---|---|
| full_name | string | The full name of the applicant |
| phone_number | string | Must be a valid mobile phone number for the applicant |
Optional Parameters:
| Parameter | Type | Description |
|---|---|---|
| referrer | string | If you want to attribute a referrer to the applicant. |
| username | string | If you want to attribute the invite to a user in your system. It should be the email address of the user. |
| send_sms | boolean | (defaults to true) If are sending the returned invite url through your own CRM or other system, set to false. |
Example Request Body
{
"full_name": "Jon Smith",
"phone_number": "254-555-1111",
"referrer": "Facebook",
"send_sms": false,
"username": "[email protected]"
}Example Response
You're returned the applicant ID as well as the URL the applicant can use to complete their application. If you opted to send the SMS invite, the applicant will have received the invite URL via SMS.
{
"applicant_id": "bafeb9a4-0aec-4bef-afbd-f7af33cc549c",
"invite_url": "https://demo.approveowl.com/i/BHydmuI"
}