Deel: Update a Shift Rate
Deel timeTracking.updateTimeTrackingShiftRateByExternalId: arguments, response, policy and SDK examples.
← Time tracking operations · Get started
Operation deel.timetracking_updatetimetrackingshiftratebyexternalid
Provider route: PATCH /time_tracking/shift_rates/{external_id}. Alter supplies the connection’s credentials and routing.
Call through Alter
Section titled “Call through Alter”Install @alter-ai/sdk @alter-ai/deel with npm, or alter-sdk-deel with pip. Supply your connected customer’s grant ID and the arguments described below.
import { App } from "@alter-ai/sdk";import { DeelIntegration } from "@alter-ai/deel";
async function execute(input: Parameters<DeelIntegration["timeTracking"]["updateTimeTrackingShiftRateByExternalId"]>[0]) { const app = new App({ apiKey: process.env.ALTER_API_KEY! }); try { const provider = new DeelIntegration(app, { grantId: process.env.PROVIDER_GRANT_ID! }); const call = await provider.timeTracking.updateTimeTrackingShiftRateByExternalId(input); const result = await call.wait(); return result.bodyJson(); } finally { await app.close(); }}import osfrom alter_sdk import Appfrom alter_sdk_deel import DeelIntegration
async def execute(arguments): async with App(api_key=os.environ["ALTER_API_KEY"]) as app: provider = DeelIntegration(app, {"grant_id": os.environ["PROVIDER_GRANT_ID"]}) call = await provider.time_tracking.update_time_tracking_shift_rate_by_external_id(arguments) result = await call.wait() return result.body_json()| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | Additional keys: not allowed |
path | object | Required within parent | Additional keys: not allowed |
path.external_id | string | Required within parent | |
body | object | Optional | |
body.data | Model | Required within parent | Expand Update a Shift Rate — request body — body data |
Referenced models: Update a Shift Rate — request body — body data
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 Update a Shift Rate — 201 response body |
Referenced models: Update a Shift Rate — 201 response body
Schemas
Section titled “Schemas”Update a Shift Rate — 201 response body
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | Shift rate policy response |
data | Model | Required within parent | Expand Update a Shift Rate — 201 response body — data |
Referenced models: Update a Shift Rate — 201 response body — data
Update a Shift Rate — request body — body data
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
name | string | Optional | The updated name of the shift rate. Maximum length: 3000 Minimum length: 1 |
type | string | Optional | The updated type of shift rate. One of: MULTIPLIER_PERCENTAGE, PER_HOUR_FLAT_RATE, PER_UNIT_FLAT_RATE |
value | number | Optional | The updated value of the shift rate. Greater than: 0 Format: double Multiple of: 0.01 |
Update a Shift Rate — 201 response body — data
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
created_at | string | Required within parent | Date when the shift rate was created Format: date-time |
external_id | string | Required within parent | ID specified by the client for uniquely identifying shift rate across organization |
name | string | Required within parent | Name of the shift rate policy |
type | string | Optional | Type of the shift rate Known values: MULTIPLIER_PERCENTAGE, PER_HOUR_FLAT_RATE, PER_UNIT_FLAT_RATE |
updated_at | string | Required within parent | Date when the shift rate was last updated Format: date-time |
value | JSON | Optional | |
value (anyOf 1) | number | Alternative | The value of the shift rate (supports up to 2 decimal places) Greater than: 0 Format: double Multiple of: 0.01 |
value (anyOf 2) | string | Alternative | Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$ |
Policy, approvals and errors
Section titled “Policy, approvals and errors”SDK function policy ID: deel.timetracking_updatetimetrackingshiftratebyexternalid. Catalog operation: timetracking_updatetimetrackingshiftratebyexternalid. 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: ["time-tracking:write"]
Pinned headers: {"X-Version": "2026-01-01"}