Skip to content

Rippling: Update custom fields for a unassigned shift

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

← Rest API operations · Get started

Operation rippling.rest_api.update_unassignedshifts_customfields

Provider route: PATCH /unassignedshifts/{id}/customfields/. 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"]["updateUnassignedshiftsCustomfields"]>[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.updateUnassignedshiftsCustomfields(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_unassignedshifts_customfields(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 parent
bodyobjectRequired within parentDictionary mapping custom field names to their values. Field names are dynamic and depend on your company’s custom field configuration.
Additional keys: allowed

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

FieldTypePresenceDescription and constraints
$objectRoot
__metaobjectOptional
__meta.redacted_fieldsarrayOptional
__meta.redacted_fields[]ModelEach itemExpand Retrieve a report run — response body — meta redacted fields item
assigned_countJSONOptional
assigned_count (anyOf 1)integerAlternativeThe number of assigned shifts
assigned_count (anyOf 2)stringAlternativePattern: ^-?[0-9]+(?:.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
assigned_shift_idsarrayOptionalThe IDs of the assigned shifts that are part of this unassigned shift
assigned_shift_ids[]stringEach item
created_atstringRequired within parentRecord creation date
custom_fieldsarrayOptionalCustom fields for the unassigned shift
custom_fields[]JSONEach itemAdditional keys: see wildcard field
custom_fields[].*JSONAdditional keys
idstringRequired within parentIdentifier field
is_publishedbooleanRequired within parentWhether the shift is published
open_shift_configobjectOptionalConfiguration for an open shift. If present, this is an open shift (workers can sign up). If absent/None, this is an empty shift (placeholder).
published_versionModelOptionalExpand Update a unassigned shift — response body — published version
scheduleModelOptionalExpand Update a shift assignment — response body — schedule
schedule_idstringRequired within parentThe ID of the schedule
shift_dataModelRequired within parentExpand Update a shift assignment — response body — shift data
target_countJSONRequired within parent
target_count (anyOf 1)integerAlternativeThe target count of the shift
target_count (anyOf 2)stringAlternativePattern: ^-?[0-9]+(?:.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
updated_atstringRequired within parentRecord update date

Referenced models: Retrieve a report run — response body — meta redacted fields item, Update a unassigned shift — response body — published version, Update a shift assignment — response body — schedule, Update a shift assignment — response body — shift data

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

Retrieve a report run — response body — meta redacted fields item
FieldTypePresenceDescription and constraints
$objectRootInfo about the redacted fields.
namestringOptionalThe name for the redacted field
reasonstringOptionalThe reason for the redaction
Update a unassigned shift — response body — published version
FieldTypePresenceDescription and constraints
$objectRootThe published version of the shift
end_timestringRequired within parentThe end time of the shift
notesstringOptionalNotes for the shift, max length 256 characters
Maximum length: 256
shift_breaksarrayOptionalThe breaks of the shift
shift_breaks[]ModelEach itemExpand Update a shift assignment — response body — shift data shift breaks item
shift_segmentsarrayOptionalThe segments of the shift
shift_segments[]ModelEach itemExpand Update a shift assignment — response body — shift data shift segments item
start_timestringRequired within parentThe start time of the shift

Referenced models: Update a shift assignment — response body — shift data shift breaks item, Update a shift assignment — response body — shift data shift segments item

Update a shift assignment — response body — schedule
FieldTypePresenceDescription and constraints
$objectRootThe schedule

Expandable field
can_editbooleanOptionalWhether the requesting role can edit the schedule.
created_atstringRequired within parentRecord creation date
idstringRequired within parentIdentifier field
managersarrayOptionalThe managers of the schedule.

Expandable field
managers[]ModelEach itemExpand Retrieve a specific worker — response body — manager
managers_idarrayOptionalThe IDs of the managers of the schedule.
managers_id[]stringEach item
membersarrayOptionalThe members of the schedule.

Expandable field
members[]ModelEach itemExpand Retrieve a specific worker — response body — manager
members_idarrayOptionalThe IDs of the members of the schedule.
members_id[]stringEach item
namestringOptionalThe name of the schedule.
observersarrayOptionalThe observers of the schedule.

Expandable field
observers[]ModelEach itemExpand Retrieve a specific worker — response body — manager
observers_idarrayOptionalThe IDs of the observers of the schedule.
observers_id[]stringEach item
settingsobjectOptionalThe settings of the schedule.
settings.timezonestringOptionalThe IANA timezone identifier for the schedule (e.g., 'America/New_York'). Accepted values are defined by the tz database, listed here: https://en.wikipedia.org/wiki/List_of_tz_database_time_zones
updated_atstringRequired within parentRecord update date

Referenced models: Retrieve a specific worker — response body — manager

Update a shift assignment — response body — shift data
FieldTypePresenceDescription and constraints
$objectRootThe data of the shift
end_timestringRequired within parentThe end time of the shift
notesstringOptionalNotes for the shift, max length 256 characters
Maximum length: 256
shift_breaksarrayOptionalThe breaks of the shift
shift_breaks[]ModelEach itemExpand Update a shift assignment — response body — shift data shift breaks item
shift_segmentsarrayOptionalThe segments of the shift
shift_segments[]ModelEach itemExpand Update a shift assignment — response body — shift data shift segments item
start_timestringRequired within parentThe start time of the shift

Referenced models: Update a shift assignment — response body — shift data shift breaks item, Update a shift assignment — response body — shift data shift segments item

Update a shift assignment — response body — shift data shift breaks item
FieldTypePresenceDescription and constraints
$objectRoot
duration_minutesJSONRequired within parent
duration_minutes (anyOf 1)integerAlternativeThe duration of the shift break in minutes (input only for creation)
duration_minutes (anyOf 2)stringAlternativePattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
end_timestringOptionalThe end time of the shift break (calculated from start_time + duration_minutes)
start_timestringRequired within parentThe start time of the shift break
typestringRequired within parentThe type of the shift break
Known values: MEAL, REST
Update a shift assignment — response body — shift data shift segments item
FieldTypePresenceDescription and constraints
$objectRoot
duration_minutesJSONRequired within parent
duration_minutes (anyOf 1)integerAlternativeThe duration of the shift segment in minutes (input only for creation)
duration_minutes (anyOf 2)stringAlternativePattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
end_timestringOptionalThe end time of the shift segment (calculated from start_time + duration_minutes)
job_codes_idarrayOptionalThe IDs of the job codes associated with the shift segment
job_codes_id[]stringEach item
start_timestringRequired within parentThe start time of the shift segment
Retrieve a specific worker — response body — business partners item
FieldTypePresenceDescription and constraints
$objectRoot
business_partner_groupobjectOptionalBusiness partner group the business partner is a part of

Expandable field
business_partner_group.created_atstringRequired within parentRecord creation date
business_partner_group.default_business_partnerModelOptionalExpand Retrieve a specific worker — response body — manager
Optional default business partner worker to whom all employees will be mapped if not explicitly mapped to a business partner in the group.

Expandable field
business_partner_group.default_business_partner_idstringOptionalId of Optional default business partner worker to whom all employees will be mapped if not explicitly mapped to a business partner in the group.
business_partner_group.domainstringOptionalType of business partner group
Known values: HR, IT, FINANCE, RECRUITING, OTHER
business_partner_group.idstringRequired within parentIdentifier field
business_partner_group.namestringRequired within parentName used to identify business partner group
business_partner_group.updated_atstringRequired within parentRecord update date
business_partner_group_idstringRequired within parentIdentifier of business partner group the business parter is a part of
client_groupModelOptionalExpand Create a new business partner — response body — client group
client_group_idstringOptionalIdentifier of group of workers associated with the business partner
client_group_member_countJSONOptional
client_group_member_count (anyOf 1)integerAlternativeNumber of workers associated with the business partner
client_group_member_count (anyOf 2)stringAlternativePattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
created_atstringRequired within parentRecord creation date
idstringRequired within parentIdentifier field
updated_atstringRequired within parentRecord update date
workerModelOptionalExpand Retrieve a specific worker — response body — manager
Worker who is the business partner

Expandable field
worker_idstringRequired within parentIdentifier of worker who is the business partner

Referenced models: Retrieve a specific worker — response body — manager, Create a new business partner — response body — client group

Retrieve a specific worker — response body — work schedule value
FieldTypePresenceDescription and constraints
$objectRootThe scheduled working hours for a day of the week.
hoursJSONOptional
hours (anyOf 1)numberAlternativeThe number of scheduled working hours for the day.
hours (anyOf 2)stringAlternativePattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$

SDK function policy ID: rippling.rest_api.update_unassignedshifts_customfields. Catalog operation: update-unassignedshifts-customfields. 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: ["unassignedshifts.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.