Rippling: Update custom fields for a unassigned shift

← rest_api operations · Get started · OpenAPI downloads

Contract 2026-10-28 · Operation rippling.rest_api.update_unassignedshifts_customfields

Provider route: PATCH /unassignedshifts/{id}/customfields/. Alter supplies the connection’s credentials and routing.

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"]["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()

Input

Field	Type	Presence	Description and constraints
$	object	Root	Additional keys: not allowed
path	object	Required within parent	Additional keys: not allowed
path.id	string	Required within parent
body	object	Required within parent	Dictionary mapping custom field names to their values. Field names are dynamic and depend on your company’s custom field configuration. Additional keys: allowed

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
__meta	object	Optional
__meta.redacted_fields	array	Optional
__meta.redacted_fields[]	Model	Each item	Expand Retrieve a report run — response body — meta redacted fields item
assigned_count	JSON	Optional
assigned_count (anyOf 1)	integer	Alternative	The number of assigned shifts
assigned_count (anyOf 2)	string	Alternative	Pattern: ^-?[0-9]+(?:.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
assigned_shift_ids	array	Optional	The IDs of the assigned shifts that are part of this unassigned shift
assigned_shift_ids[]	string	Each item
created_at	string	Required within parent	Record creation date
custom_fields	array	Optional	Custom fields for the unassigned shift
custom_fields[]	JSON	Each item	Additional keys: see wildcard field
custom_fields[].*	JSON	Additional keys
id	string	Required within parent	Identifier field
is_published	boolean	Required within parent	Whether the shift is published
open_shift_config	object	Optional	Configuration 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_version	Model	Optional	Expand Update a unassigned shift — response body — published version
schedule	Model	Optional	Expand Update a shift assignment — response body — schedule
schedule_id	string	Required within parent	The ID of the schedule
shift_data	Model	Required within parent	Expand Update a shift assignment — response body — shift data
target_count	JSON	Required within parent
target_count (anyOf 1)	integer	Alternative	The target count of the shift
target_count (anyOf 2)	string	Alternative	Pattern: ^-?[0-9]+(?:.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
updated_at	string	Required within parent	Record 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

Policy, approvals and errors

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