Skip to main content
PUT
Update a member

Authorizations

X-API-KEY
string
header
required

Path Parameters

id
string<uuid>
required
Pattern: ^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12})$

Body

application/json
is_admin
boolean
department_ids
object[]
Minimum array length: 1
employment_start_date
string | null

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_date
string | null

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_id
string
birthday
string | null

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. Date of birth. A new value must not be in the future and must give an age from 10 to 100, otherwise the request is rejected with 400. Sending back the stored value unchanged is always accepted. null clears it.

custom_id
string | null
business_phone
string | null

Business phone number. Up to 64 characters of digits, spaces and + - ( ) . /, with an optional extension (ext or x). null or an empty string clears it. Refused with 400 while the member is synced from Microsoft, and for a value that does not follow these rules.

Maximum string length: 64
status
enum<string>
Available options:
INACTIVE,
ACTIVE,
ARCHIVED

Response

Successful response

The response is of type string<uuid>.

Pattern: ^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12})$