RErecruitwithatlas
Projects

Create an applicant

Changed on

Use this endpoint to create an applicant on a project from an uploaded resume file.

Unlike candidates (where you add an existing person to a project), applicants are created from a resume file that has been uploaded via the Files endpoint. Atlas will automatically parse the resume and score the applicant against project criteria.

What you need to provide:

  • The project ID in the URL path
  • A file_id in the request body - the ID of a previously uploaded resume file (must be type "resume")
  • Optionally, applicant details (name, email, phone, etc.) - if omitted, these are extracted from the resume

To get a file ID, first upload the resume using the Upload a file endpoint.

post/api/v1/projects/{id}/applicants

Request

Path parameters

idstring uuid required

Project ID

Example:550e8400-e29b-41d4-a716-446655440000

Request body

fileIdstring uuid required

ID of the uploaded file (must be type "resume")

firstNamestring nullable

First name

lastNamestring nullable

Last name

emailstring email nullable

Email address

phonestring nullable

Phone number

currentRolestring nullable

Current job title

currentEmployerstring nullable

Current employer

source'form' | 'manual_upload' | 'api'

Applicant source

notesstring nullable

Free-text notes

Example request

{
  "fileId": "550e8400-e29b-41d4-a716-446655440000",
  "firstName": "Jane",
  "lastName": "Doe",
  "email": "jane.doe@example.com",
  "phone": "+442071234567",
  "currentRole": "Software Engineer",
  "currentEmployer": "Acme Corp",
  "source": "api",
  "notes": "Referred by internal team"
}

Response

Applicant created

status'ok' required

Example response

{
  "data": {
    "status": "pending",
    "source": "api"
  }
}

Changes