Rippling: Create a new job requisition
Rippling restApi.createJobRequisitionsWrite: arguments, response, policy and SDK examples.
← rest_api operations · Get started · OpenAPI downloads
Contract 2026-10-28 · Operation rippling.rest_api.create_job_requisitions_write
Provider route: POST /job-requisitions-write/. 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["restApi"]["createJobRequisitionsWrite"]>[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.restApi.createJobRequisitionsWrite(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.rest_api.create_job_requisitions_write(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 Create a new job requisition — request body — body |
Referenced models: Create a new job requisition — 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 |
|---|---|---|---|
$ | object | Root | DTO for creating JobRequisitions via the Platform API. Maps to the existing ATS JobRequisitionDTO for use with create_from_DTO service. |
confidential | boolean | Optional | Whether this requisition is confidential |
confidential_whitelist | array | Optional | List of role IDs allowed to view confidential requisition |
confidential_whitelist[] | string | Each item | |
coordinator_id | string | Optional | Coordinator role ID |
created_at | string | Required within parent | Record creation date |
default_private_invites | boolean | Optional | Whether to default to private invites |
departments | array | Optional | List of department IDs |
departments[] | string | Each item | |
description | string | Optional | Job description |
employment_type_id | string | Optional | Company employment type ID |
hiring_manager_id | string | Optional | Hiring manager role ID |
id | string | Required within parent | Identifier field |
is_evergreen | boolean | Optional | Whether this is an evergreen requisition |
levels | array | Optional | List of level IDs |
levels[] | string | Each item | |
name | string | Required within parent | Title/name of the job requisition |
pipeline_plan_id | string | Optional | Pipeline plan ID to use for this requisition |
recruiter_id | string | Optional | Primary recruiter role ID |
requisition_id | string | Optional | Customer-defined requisition ID. Auto-generated if not provided. |
salary_currency | string | Optional | Salary currency code |
salary_per_unit | JSON | Optional | |
salary_per_unit (anyOf 1) | number | Alternative | Salary amount per unit |
salary_per_unit (anyOf 2) | string | Alternative | Pattern: ^-?[0-9]+(?:.[0-9]+)?(?:[eE][+-]?[0-9]+)?$ |
salary_per_unit_high | JSON | Optional | |
salary_per_unit_high (anyOf 1) | number | Alternative | Salary range upper bound |
salary_per_unit_high (anyOf 2) | string | Alternative | Pattern: ^-?[0-9]+(?:.[0-9]+)?(?:[eE][+-]?[0-9]+)?$ |
salary_per_unit_low | JSON | Optional | |
salary_per_unit_low (anyOf 1) | number | Alternative | Salary range lower bound |
salary_per_unit_low (anyOf 2) | string | Alternative | Pattern: ^-?[0-9]+(?:.[0-9]+)?(?:[eE][+-]?[0-9]+)?$ |
salary_type | string | Optional | Salary type |
salary_unit | string | Optional | Salary unit (HOUR, DAY, WEEK, MONTH, YEAR, PAY_PERIOD) |
secondary_recruiters | array | Optional | List of secondary recruiter role IDs |
secondary_recruiters[] | string | Each item | |
sourcer_id | string | Optional | Sourcer role ID |
status | string | Optional | Job requisition status (e.g., DRAFT, OPEN, CLOSED) |
target_close | string | Optional | Target close date |
target_employee_start_date | string | Optional | Target employee start date |
teams | array | Optional | List of team IDs |
teams[] | string | Each item | |
title | string | Optional | Internal employee title |
updated_at | string | Required within parent | Record update date |
work_locations | array | Optional | List of work location IDs |
work_locations[] | string | Each item |
Policy, approvals and errors
Section titled “Policy, approvals and errors”SDK function policy ID: rippling.rest_api.create_job_requisitions_write. Catalog operation: create-job-requisitions-write. 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.
Required provider scopes: ["job-requisitions-write.read-write"]
Provider entitlements: ["API_Tier_1"]
Pinned headers: {"Rippling-Api-Version": "2024-08-01"}