post

https://partners.apploi.com/easy-apply

This endpoint is used to submit applications for candidates.

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Body Params

Pass in a JSON body with applicant details in this format:

    {
        "id": "12345",
        "get_person_token": True,
        "partner_attributes": {
            "sponsored": false,
        },
        "applicant_status": "New",
        "applicant": {
            "email": "[email protected]",
            "fullName": "John Doe",
            "phoneNumber": "123-456-7890",
            "source": "linkedin",
            "utm_source": "linkedin",
            "utm_medium": "social",
            "utm_campaign": "spring_campaign",
            "resume": {
                "file": {
                    "fileName": "resume.pdf",
                    "contentType": "application/pdf",
                    "data": "base64_encoded_resume_content",
                }
            },
        },
        "appliedOnMillis": 1672531199000,
        "job": {
            "jobId": "67890"
        },
        "questions": {
            "answers": [
                {
                    "id": "1",
                    "value": "Yes"
                },
                {
                    "id": "2",
                    "values": ["Option1", "Option2"]
                }
            ]
        },
        "interview": {
            "date": "2024-10-22T14:00:00Z",
            "duration": "60",
            "timezone": "America/New_York",
            "location": "Virtual",
            "interviewerId": "123"
        }
    }

applicant

object

required

Contains the applicant information

applicant_status

string

Defaults to New

This field is used to set the status of the candidate's application upon creation. The value of this field is expected to be a string which corresponds to a valid application status in the Apploi platform found in the Application Stage Manager page of the Apploi platform in which custom application statuses can be created. The value of this field is case-sensitive: it must precisely match the name of the status in the Apploi platform. If the interview key is present in the request, the value of this field will be ignored and the status of the candidate's application will be automatically set to 'Interview Scheduled'.

examples: New, Interview Scheduled, Hired, Rejected, etc.

appliedOnMillis

integer

Defaults to 1672531199000

Timestamp of the application

get_person_token

boolean

Defaults to true

True to get the person token to use later to obtain the basic info of the applicant.

string

Defaults to 12345

The id of the application in the external service

interview

object

An interview information object used to schedule an interview when the application is created. If this field is present in the request, the status of the candidate's application will be automatically set to 'Interview Scheduled'. This will override the value of the applicant_status field if it is also present in the request.

job

object

required

Job information object

partner_attributes

object

required

Metadata related to the job and the origin of the application.

questions

object

Responses

409

Duplicate application: We define duplicate as an application from the same job seeker email, to the same jobid

410

If a job post is expired or no longer available.

503

request took longer than 30 seconds to complete.

200200 response