Schedule worker attribute changes

put

https://services.fountain.com/api/serviceworkforce/processes/workers/{workerIdentifier}/scheduledAttributeChanges

Set worker attribute values to take effect at the dates and times specified in the request.

Records one or more attribute changes to take effect at the start of the given day in the company's timezone. Until then the worker keeps its current values everywhere — segments, automations and exports all continue to see the old value. Scheduling a new value for an attribute that already has a pending change supersedes it. Responds 202 when the change was scheduled, and 200 with appliedNow: true when the date had already passed and the change was written immediately.

Path Params

workerIdentifier

uuid

required

worker unique identifier

Body Params

effectiveDate

date

required

The day the changes take effect, at the start of that day in the company's timezone (UTC when the company has none set). Required: this route only schedules, so a request without a date is rejected — use the customAttributes or worker PATCH routes to write a value now. A date that has already arrived is written immediately and answers 200.

changes

array of objects

required

length ≥ 1

changes*

targetKind

string

enum

required

Allowed:

customAttributeUuid

uuid

Required when targetKind is custom.

field

string

Required when targetKind is core. A dot path into the worker, e.g. payRate, homeAddress.city. Derived, identity and audit fields cannot be scheduled.

value

string

required

The future value, validated against the field or attribute type. null clears it.

Responses

Language

Credentials

OAuth2

Loading…

Response

Click Try It! to start a request and see the response here! Or choose an example:

application/json

200The effective date has already arrived; nothing was scheduled

202Changes scheduled