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.
Call through Alter
Section titled “Call through Alter”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 osfrom alter_sdk import Appfrom 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()| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | Additional keys: not allowed |
body | Model | Optional | Expand POST New Candidate — request body — body |
Referenced models: POST New Candidate — request body — body
Response
Section titled “Response”Response media type: application/json. The table describes the pinned successful response. Referenced models link to their complete fields.
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | Model | Root | Expand POST New Candidate — response body |
Referenced models: POST New Candidate — response body
Schemas
Section titled “Schemas”POST New Candidate — request body — body
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | The Rippling candidate model. |
attachments | array | Optional | |
attachments[] | object | Each item | An array of json objects containing file names and public file URLs containing documents pertaining to the candidate. |
attachments[].file_name | string | Optional | The file name. |
attachments[].file_url | string | Optional | The public URL and name of a pdf/docx/doc/odt file containing documents pertaining to the candidate. |
candidateId | string | Optional | The unique identifier of the candidate from the ATS. |
currency | string | Optional | A string field of the official currency as listed in ISO 4217. |
department | string | Optional | This is the id of the department from GET/departments. |
email | string | Optional | The candidate's email. |
employmentType | string | Optional | An 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 |
equityShares | integer | Optional | The number of shares that will be given to the candidate. |
jobTitle | string | Optional | The candidate's job title. |
name | string | Optional | The candidate's name. |
phoneNumber | string | Optional | The candidate's phone number. |
salaryPerUnit | number | Optional | The decimal value that the candidate gets paid every salaryUnit time period. |
salaryUnit | string | Optional | 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. One of: HOUR, DAY, WEEK, MONTH, PAY_PERIOD |
signingBonus | number | Optional | The bonus cash given to the candidate as a part of a one time payment, with two decimal digit precision. Format: double |
startDate | string | Optional | The would-be start date of the candidate. Format: date |
workLocation | string | Optional | This is the id of the worklocation from GET/work_locations. |
POST New Candidate — response body
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | The Rippling candidate model. |
attachments | array | Optional | |
attachments[] | object | Each item | An array of json objects containing file names and public file URLs containing documents pertaining to the candidate. |
attachments[].file_name | string | Optional | The file name. |
attachments[].file_url | string | Optional | The public URL and name of a pdf/docx/doc/odt file containing documents pertaining to the candidate. |
candidateId | string | Optional | The unique identifier of the candidate from the ATS. |
currency | string | Optional | A string field of the official currency as listed in ISO 4217. |
department | string | Optional | This is the id of the department from GET/departments. |
email | string | Optional | The candidate's email. |
employmentType | string | Optional | An 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 |
equityShares | JSON | Optional | |
equityShares (anyOf 1) | integer | Alternative | The number of shares that will be given to the candidate. |
equityShares (anyOf 2) | string | Alternative | Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$ |
jobTitle | string | Optional | The candidate's job title. |
name | string | Optional | The candidate's name. |
phoneNumber | string | Optional | The candidate's phone number. |
salaryPerUnit | JSON | Optional | |
salaryPerUnit (anyOf 1) | number | Alternative | The decimal value that the candidate gets paid every salaryUnit time period. |
salaryPerUnit (anyOf 2) | string | Alternative | Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$ |
salaryUnit | string | Optional | 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. Known values: HOUR, DAY, WEEK, MONTH, PAY_PERIOD |
signingBonus | JSON | Optional | |
signingBonus (anyOf 1) | number | Alternative | The bonus cash given to the candidate as a part of a one time payment, with two decimal digit precision. Format: double |
signingBonus (anyOf 2) | string | Alternative | Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$ |
startDate | string | Optional | The would-be start date of the candidate. Format: date |
workLocation | string | Optional | This is the id of the worklocation from GET/work_locations. |
Policy, approvals and errors
Section titled “Policy, approvals and errors”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.