Skip to content

Rippling: POST New Candidate

Rippling baseApi.postAtsCandidatesPushCandidate: arguments, response, policy and SDK examples.

← Base API operations · Get started

Operation rippling.base_api.post_ats_candidates_push_candidate

Provider route: POST /platform/api/ats_candidates/push_candidate. Alter supplies the connection’s credentials and routing.

Install @alter-ai/sdk @alter-ai/rippling with npm, or alter-sdk-rippling with pip. Supply your connected customer’s grant ID and the arguments described below.

import { App } from "@alter-ai/sdk";
import { RipplingIntegration } from "@alter-ai/rippling";
async function execute(input: Parameters<RipplingIntegration["baseApi"]["postAtsCandidatesPushCandidate"]>[0]) {
const app = new App({ apiKey: process.env.ALTER_API_KEY! });
try {
const provider = new RipplingIntegration(app, { grantId: process.env.PROVIDER_GRANT_ID! });
const call = await provider.baseApi.postAtsCandidatesPushCandidate(input);
const result = await call.wait();
return result.bodyJson();
} finally {
await app.close();
}
}
import os
from alter_sdk import App
from alter_sdk_rippling import RipplingIntegration
async def execute(arguments):
async with App(api_key=os.environ["ALTER_API_KEY"]) as app:
provider = RipplingIntegration(app, {"grant_id": os.environ["PROVIDER_GRANT_ID"]})
call = await provider.base_api.post_ats_candidates_push_candidate(arguments)
result = await call.wait()
return result.body_json()
FieldTypePresenceDescription and constraints
$objectRootAdditional keys: not allowed
bodyModelOptionalExpand POST New Candidate — request body — body

Referenced models: POST New Candidate — request body — body

Response media type: application/json. The table describes the pinned successful response. Referenced models link to their complete fields.

FieldTypePresenceDescription and constraints
$ModelRootExpand POST New Candidate — response body

Referenced models: POST New Candidate — response body

POST New Candidate — request body — body
FieldTypePresenceDescription and constraints
$objectRootThe Rippling candidate model.
attachmentsarrayOptional
attachments[]objectEach itemAn array of json objects containing file names and public file URLs containing documents pertaining to the candidate.
attachments[].file_namestringOptionalThe file name.
attachments[].file_urlstringOptionalThe public URL and name of a pdf/docx/doc/odt file containing documents pertaining to the candidate.
candidateIdstringOptionalThe unique identifier of the candidate from the ATS.
currencystringOptionalA string field of the official currency as listed in ISO 4217.
departmentstringOptionalThis is the id of the department from GET/departments.
emailstringOptionalThe candidate's email.
employmentTypestringOptionalAn ENUM of employment type. Will default to one of these six values unless the employee's profile has a job display name configured.
One of: CONTRACTOR, SALARIED_PT, SALARIED_FT, HOURLY_FT, HOURLY_PT, TEMP
equitySharesintegerOptionalThe number of shares that will be given to the candidate.
jobTitlestringOptionalThe candidate's job title.
namestringOptionalThe candidate's name.
phoneNumberstringOptionalThe candidate's phone number.
salaryPerUnitnumberOptionalThe decimal value that the candidate gets paid every salaryUnit time period.
salaryUnitstringOptionalAn 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.
One of: HOUR, DAY, WEEK, MONTH, PAY_PERIOD
signingBonusnumberOptionalThe bonus cash given to the candidate as a part of a one time payment, with two decimal digit precision.
Format: double
startDatestringOptionalThe would-be start date of the candidate.
Format: date
workLocationstringOptionalThis is the id of the worklocation from GET/work_locations.
POST New Candidate — response body
FieldTypePresenceDescription and constraints
$objectRootThe Rippling candidate model.
attachmentsarrayOptional
attachments[]objectEach itemAn array of json objects containing file names and public file URLs containing documents pertaining to the candidate.
attachments[].file_namestringOptionalThe file name.
attachments[].file_urlstringOptionalThe public URL and name of a pdf/docx/doc/odt file containing documents pertaining to the candidate.
candidateIdstringOptionalThe unique identifier of the candidate from the ATS.
currencystringOptionalA string field of the official currency as listed in ISO 4217.
departmentstringOptionalThis is the id of the department from GET/departments.
emailstringOptionalThe candidate's email.
employmentTypestringOptionalAn ENUM of employment type. Will default to one of these six values unless the employee's profile has a job display name configured.
Known values: CONTRACTOR, SALARIED_PT, SALARIED_FT, HOURLY_FT, HOURLY_PT, TEMP
equitySharesJSONOptional
equityShares (anyOf 1)integerAlternativeThe number of shares that will be given to the candidate.
equityShares (anyOf 2)stringAlternativePattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
jobTitlestringOptionalThe candidate's job title.
namestringOptionalThe candidate's name.
phoneNumberstringOptionalThe candidate's phone number.
salaryPerUnitJSONOptional
salaryPerUnit (anyOf 1)numberAlternativeThe decimal value that the candidate gets paid every salaryUnit time period.
salaryPerUnit (anyOf 2)stringAlternativePattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
salaryUnitstringOptionalAn 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.
Known values: HOUR, DAY, WEEK, MONTH, PAY_PERIOD
signingBonusJSONOptional
signingBonus (anyOf 1)numberAlternativeThe bonus cash given to the candidate as a part of a one time payment, with two decimal digit precision.
Format: double
signingBonus (anyOf 2)stringAlternativePattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
startDatestringOptionalThe would-be start date of the candidate.
Format: date
workLocationstringOptionalThis is the id of the worklocation from GET/work_locations.

SDK function policy ID: rippling.base_api.post_ats_candidates_push_candidate. Catalog operation: v1.post-ats_candidates-push_candidate. Rules can name either ID; function rules distinguish managed calls and conservatively cover raw calls sharing the route. Existing grant permissions and policy rules apply. wait() returns an immediate result or waits for a required approval; it never approves the request itself. Persist the approval ID to resume after a restart.

Provider errors retain their response; JSON decoding raises ProviderAPIError for provider failures. ManagedOperationError identifies contract/input/retention errors. See error handling and provider-specific behavior. Sensitive input may be refused before approval storage. A decoding error never resubmits a write.

Official provider source

Report an issue with this page

Necessary

Required for sign-in, security, authorization, and remembering your choices.

Always active

Analytics

Helps us understand which product and documentation features are useful.

Performance diagnostics

Uses performance tracing and privacy-masked session replay to diagnose problems.

You can change these choices at any time from Cookie settings.