API Reference

Update key dates on a user program

patch
https://{customerDomain}.heyteam.com/eapi/programs//key-dates

Update one or more key dates of a user program in a single request.

Supported program statuses: draft and active. A program in completed status returns 409 Conflict.

Several key dates can be updated in a single call. If any value fails validation, no change is applied.

When a key date is updated, deadlines of the related tasks are recomputed. When the updated key date is the main key date of an onboarding, the user's arrival date is refreshed accordingly.

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Path Params
string
required

User Program Id

Body Params
key_dates
array of objects
required
length ≥ 1

List of key dates to update. At least one entry is required. Each slug must belong to the program template and must be distinct within the payload.

key_dates*
string
required

Key date slug. Must be one of the key dates configured on the program template.
Available values: arrival-date, program-creation-date, pre-hire-date, calendar-date, probation-period-end-date, changing-job-position-date, departure-date, return-date, contract-end-date, end-of-contract-notice, end-of-training-period, effective-entry, start-date-of-the-stop, start-date-of-the-notice-period, start-date-of-the-training.

date
required

New date using YYYY-MM-DD format (ISO 8601).

Responses

Updated about 2 months ago

Language
Credentials
URL
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json

Updated about 2 months ago