latestOpenAPI 3.1.02026-08-22695252.1 KB

ef777d51e6f2

Members

Update a member

Update a member. Employment period: changing employment_start_date or employment_end_date so that absences currently inside the period would fall outside the new one is rejected with 400 (error code EMPLOYMENT_PERIOD_ABSENCES_AFFECTED, including the affected counts). Absences that already sat outside the stored period do not by themselves block a change, so existing absences never stand in the way of widening the period. The API never cancels absences; resolve them in the absentify UI, which asks for explicit confirmation before cancelling. Clearing employment_start_date (setting it to null) is rejected with 400 while the member has an ACTIVE assignment to an allowance rule that anchors its accrual year on the hire date (an assignment whose rule_end_date has already passed does not block it) — that rule has nothing to anchor on without the date, and the response names the rule. Either move the member to a rule with a fixed year start first, or keep the date. Setting or changing the date is unaffected, and a member who already has no date stays editable.

put/members/{id}

Path parameters

idstring uuid required

Request body

is_adminboolean
employment_start_datestring nullable

Date/time in ISO 8601 format, e.g. 2026-06-01 (interpreted as UTC midnight) or 2026-06-01T09:00:00Z. Always include a time zone designator (Z for UTC) when sending a time of day. Localized formats such as 01.06.2026 or 06/01/2026 are misinterpreted and must not be used.

employment_end_datestring nullable

Date/time in ISO 8601 format, e.g. 2026-06-01 (interpreted as UTC midnight) or 2026-06-01T09:00:00Z. Always include a time zone designator (Z for UTC) when sending a time of day. Localized formats such as 01.06.2026 or 06/01/2026 are misinterpreted and must not be used.

public_holiday_idstring
birthdaystring nullable

Date/time in ISO 8601 format, e.g. 2026-06-01 (interpreted as UTC midnight) or 2026-06-01T09:00:00Z. Always include a time zone designator (Z for UTC) when sending a time of day. Localized formats such as 01.06.2026 or 06/01/2026 are misinterpreted and must not be used.

custom_idstring nullable
status'INACTIVE' | 'ACTIVE' | 'ARCHIVED'

Response

Successful response

string uuid required