Skip to content

Rippling: Update a job assignment

Rippling restApi.updateJobAssignments: arguments, response, policy and SDK examples.

← Rest API operations · Get started

Operation rippling.rest_api.update_job_assignments

Provider route: PATCH /job-assignments/{id}/. 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["restApi"]["updateJobAssignments"]>[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.updateJobAssignments(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.rest_api.update_job_assignments(arguments)
result = await call.wait()
return result.body_json()
FieldTypePresenceDescription and constraints
$objectRootAdditional keys: not allowed
pathobjectRequired within parentAdditional keys: not allowed
path.idstringRequired within parentFormat: id
bodyModelOptionalExpand Update a job assignment — request body — body

Referenced models: Update a job assignment — 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
$objectRoot
base_pay_rateJSONOptional
base_pay_rate (anyOf 1)numberAlternativeBase compensation rate of worker
base_pay_rate (anyOf 2)stringAlternativePattern: ^-?[0-9]+(?:.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
created_atstringRequired within parentRecord creation date
idstringRequired within parentIdentifier field
job_codeModelOptionalExpand Update a job assignment — response body — job code
job_code_idstringRequired within parentIdentifier of job that is assigned to worker
job_pay_rateJSONOptional
job_pay_rate (anyOf 1)numberAlternativeThe pay rate for job assigned to worker. This can be different from the job’s standard pay rate and can be overriden for a worker.
job_pay_rate (anyOf 2)stringAlternativePattern: ^-?[0-9]+(?:.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
job_pay_rate_exceptionsarrayOptionalPay rate exceptions applicable for the worker based on certain exception dimension values.

Expandable field
job_pay_rate_exceptions[]ModelEach itemExpand List job pay rate exceptions — response body — results item
job_pay_rate_exceptions_idarrayOptionalIdentifier of pay rate exceptions applicable for the worker based on certain exception dimension values.
job_pay_rate_exceptions_id[]stringEach item
updated_atstringRequired within parentRecord update date
workerModelOptionalExpand Update a job assignment — response body — worker
worker_idstringRequired within parentIdentifier of worker to whom job is assigned.

Referenced models: List job pay rate exceptions — response body — results item, Update a job assignment — response body — job code, Update a job assignment — response body — worker

34 more schemas are linked from the tables above, on the schema pages.

List job pay rate exceptions — response body — results item
FieldTypePresenceDescription and constraints
$objectRoot
created_atstringRequired within parentRecord creation date
exception_dimension_idstringRequired within parentIdentifier of dimension object on which exception is configured. This objects details can be queried from exception_dimension_type's resource
exception_dimension_typestringOptionalType of dimension on which exception is configured
Known values: JOB_CODE, LEVEL, TEAM, DEPARTMENT, WORK_LOCATION
idstringRequired within parentIdentifier field
job_codeModelOptionalExpand Retrieve a specific job pay rate exception — response body — job code
job_code_idstringRequired within parentIdentifier of Job for which exception is configured.
pay_rateJSONRequired within parent
pay_rate (anyOf 1)numberAlternativeThe pay rate for exception on job_code_id and exception_dimension_id combination
pay_rate (anyOf 2)stringAlternativePattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
updated_atstringRequired within parentRecord update date

Referenced models: Retrieve a specific job pay rate exception — response body — job code

Update a job assignment — request body — body
FieldTypePresenceDescription and constraints
$objectRoot
change_reasonstringOptionalReason recorded on the change (e.g., the reason for scheduling an unassignment).
effective_fromstringOptionalDate and time the change becomes effective (ISO 8601 format, e.g., 2025-11-07T17:00:00.000+00:00); defaults to current time in UTC if not provided. job_pay_rate_effective_from is ignored if this field is provided.
job_code_idstringOptionalIdentifier of job that is assigned to worker
job_pay_ratenumberOptionalThe pay rate for job assigned to worker. This can be different from the job's standard pay rate and can be overriden for a worker.
job_pay_rate_change_reasonstringOptionalThis field is deprecated and will be removed in a future version, use the new change_reason field instead.
job_pay_rate_effective_fromstringOptionalThis field is deprecated and will be removed in a future version, use the new effective_from field instead.
worker_idstringOptionalIdentifier of worker to whom job is assigned.
Update a job assignment — response body — job code
FieldTypePresenceDescription and constraints
$objectRootJob that is assigned to worker

Expandable field
created_atstringRequired within parentRecord creation date
custom_locationModelOptionalExpand Update a job code — response body — custom location
departmentModelOptionalExpand Update a job code — response body — department
department_idstringOptionalThe department associated with the job code.
external_idstringOptionalThe unique identifier of the job code in an outside system.
group_idstringOptionalThe ID of the job roster group.
idstringRequired within parentIdentifier field
is_archivedbooleanOptionalWhether this job code is archived. Set to true via PATCH to archive. Archiving is irreversible via this API.
job_dimensionModelOptionalExpand Update a job code — response body — job dimension
job_dimension_idstringRequired within parentThe ID of the job dimension this job code belongs to.
namestringRequired within parentThe name of the job dimension.
pay_rateJSONOptional
pay_rate (anyOf 1)numberAlternativeThe pay rate for this job code. Only applicable if the associated job dimension includes the 'PAY_RATE' organizational attribute.
pay_rate (anyOf 2)stringAlternativePattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
pay_rate_exceptionsarrayOptionalPay rate overrides for the job based on exception dimension values.

Expandable field
pay_rate_exceptions[]ModelEach itemExpand Update a job code — response body — pay rate exceptions item
pay_rate_exceptions_idarrayOptionalPay rate overrides id for the job based on exception dimension values.
pay_rate_exceptions_id[]stringEach item
updated_atstringRequired within parentRecord update date
work_locationModelOptionalExpand Update a job code — response body — work location
work_location_idstringOptionalThe work location associated with the job code.

Referenced models: Update a job code — response body — pay rate exceptions item, Update a job code — response body — custom location, Update a job code — response body — department, Update a job code — response body — job dimension, Update a job code — response body — work location

Retrieve a specific job pay rate exception — response body — job code
FieldTypePresenceDescription and constraints
$objectRootJob for which exception is configured.

Expandable field
created_atstringRequired within parentRecord creation date
custom_locationModelOptionalExpand Update a job code — response body — custom location
departmentModelOptionalExpand Update a job code — response body — department
department_idstringOptionalThe department associated with the job code.
external_idstringOptionalThe unique identifier of the job code in an outside system.
group_idstringOptionalThe ID of the job roster group.
idstringRequired within parentIdentifier field
is_archivedbooleanOptionalWhether this job code is archived. Set to true via PATCH to archive. Archiving is irreversible via this API.
job_dimensionModelOptionalExpand Update a job code — response body — job dimension
job_dimension_idstringRequired within parentThe ID of the job dimension this job code belongs to.
namestringRequired within parentThe name of the job dimension.
pay_rateJSONOptional
pay_rate (anyOf 1)numberAlternativeThe pay rate for this job code. Only applicable if the associated job dimension includes the 'PAY_RATE' organizational attribute.
pay_rate (anyOf 2)stringAlternativePattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
pay_rate_exceptionsarrayOptionalPay rate overrides for the job based on exception dimension values.

Expandable field
pay_rate_exceptions[]ModelEach itemExpand List job pay rate exceptions — response body — results item
pay_rate_exceptions_idarrayOptionalPay rate overrides id for the job based on exception dimension values.
pay_rate_exceptions_id[]stringEach item
updated_atstringRequired within parentRecord update date
work_locationModelOptionalExpand Update a job code — response body — work location
work_location_idstringOptionalThe work location associated with the job code.

Referenced models: List job pay rate exceptions — response body — results item, Update a job code — response body — custom location, Update a job code — response body — department, Update a job code — response body — job dimension, Update a job code — response body — work location

Update a job code — response body — pay rate exceptions item
FieldTypePresenceDescription and constraints
$objectRoot
created_atstringRequired within parentRecord creation date
exception_dimension_idstringRequired within parentIdentifier of dimension object on which exception is configured. This objects details can be queried from exception_dimension_type's resource
exception_dimension_typestringOptionalType of dimension on which exception is configured
Known values: JOB_CODE, LEVEL, TEAM, DEPARTMENT, WORK_LOCATION
idstringRequired within parentIdentifier field
job_codeModelOptionalExpand List job codes — response body — results item
Job for which exception is configured.

Expandable field
job_code_idstringRequired within parentIdentifier of Job for which exception is configured.
pay_rateJSONRequired within parent
pay_rate (anyOf 1)numberAlternativeThe pay rate for exception on job_code_id and exception_dimension_id combination
pay_rate (anyOf 2)stringAlternativePattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
updated_atstringRequired within parentRecord update date

Referenced models: List job codes — response body — results item

SDK function policy ID: rippling.rest_api.update_job_assignments. Catalog operation: update-job-assignments. 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-assignments.read-write"]

Provider entitlements: ["API_Tier_1"]

Pinned headers: {"Rippling-Api-Version": "2024-08-01"}

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.