POST New Candidate

Pushes a candidate from an applicant tracking system directly into the Rippling onboarding flow. Please note, this endpoint is only available to applications integrating with OAuth2.0.

NOTE: This endpoint is NOT available for use with Rippling customer API Keys.

POST /platform/api/ats_candidates/push_candidate

POST New Candidate

cURL

curl --request POST \
  --url https://api.rippling.com/platform/api/ats_candidates/push_candidate \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "name": "<string>",
  "email": "<string>",
  "jobTitle": "<string>",
  "phoneNumber": "<string>",
  "candidateId": "<string>",
  "startDate": "2023-12-25",
  "salaryUnit": "HOUR",
  "salaryPerUnit": 123,
  "signingBonus": 123,
  "currency": "<string>",
  "equityShares": 123,
  "department": "<string>",
  "employmentType": "CONTRACTOR",
  "workLocation": "<string>",
  "attachments": [
    {
      "file_name": "<string>",
      "file_url": "<string>"
    }
  ]
}
'

200

{
  "name": "<string>",
  "email": "<string>",
  "jobTitle": "<string>",
  "phoneNumber": "<string>",
  "candidateId": "<string>",
  "startDate": "2023-12-25",
  "salaryUnit": "HOUR",
  "salaryPerUnit": 123,
  "signingBonus": 123,
  "currency": "<string>",
  "equityShares": 123,
  "department": "<string>",
  "employmentType": "CONTRACTOR",
  "workLocation": "<string>",
  "attachments": [
    {
      "file_name": "<string>",
      "file_url": "<string>"
    }
  ]
}

Authorizations

Authorization · string · header · required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Body

application/json

The Rippling candidate model.

name · string

The candidate's name.

email · string

The candidate's email.

jobTitle · string

The candidate's job title.

phoneNumber · string

The candidate's phone number.

candidateId · string

The unique identifier of the candidate from the ATS.

startDate · string<date>

The would-be start date of the candidate.

salaryUnit · enum<string>

An ENUM string value, denoting the frequency at which the candidate should be paid once the role begins. Note, the PAY_PERIOD ENUM implies the candidate is paid as per a custom pay period.

Available options: HOUR, DAY, WEEK, MONTH, PAY_PERIOD

salaryPerUnit · number

The decimal value that the candidate gets paid every salaryUnit time period.

signingBonus · number<double>

The bonus cash given to the candidate as a part of a one time payment, with two decimal digit precision.

currency · string

A string field of the official currency as listed in ISO 4217.

equityShares · integer

The number of shares that will be given to the candidate.

department · string

This is the id of the department from GET/departments.

employmentType · enum<string>

The ENUM type of employment the user will have within Rippling.

Available options: CONTRACTOR, SALARIED_PT, SALARIED_FT, HOURLY_FT, HOURLY_PT, TEMP

workLocation · string

This is the id of the worklocation from GET/work_locations.

attachments · object[]

Show child attributes

Response

200 - application/json

OK

The Rippling candidate model.

name · string

The candidate's name.

email · string

The candidate's email.

jobTitle · string

The candidate's job title.

phoneNumber · string

The candidate's phone number.

candidateId · string

The unique identifier of the candidate from the ATS.

startDate · string<date>

The would-be start date of the candidate.

salaryUnit · enum<string>

An ENUM string value, denoting the frequency at which the candidate should be paid once the role begins. Note, the PAY_PERIOD ENUM implies the candidate is paid as per a custom pay period.

Available options: HOUR, DAY, WEEK, MONTH, PAY_PERIOD

salaryPerUnit · number

The decimal value that the candidate gets paid every salaryUnit time period.

signingBonus · number<double>

The bonus cash given to the candidate as a part of a one time payment, with two decimal digit precision.

currency · string

A string field of the official currency as listed in ISO 4217.

equityShares · integer

The number of shares that will be given to the candidate.

department · string

This is the id of the department from GET/departments.

employmentType · enum<string>

The ENUM type of employment the user will have within Rippling.

Available options: CONTRACTOR, SALARIED_PT, SALARIED_FT, HOURLY_FT, HOURLY_PT, TEMP

workLocation · string

This is the id of the worklocation from GET/work_locations.

attachments · object[]

Show child attributes