Skip to main content
POST
Invite a member

Authorizations

X-API-KEY
string
header
required

Body

application/json
name
string
required
Maximum string length: 255
email
string<email> | null
required
Pattern: ^(?:[A-Za-z0-9_'+\-]+\.)*[A-Za-z0-9_'+\-]*[A-Za-z0-9_+-]@(?:[A-Za-z0-9][A-Za-z0-9\-]*\.)+[A-Za-z]{2,}$
department_ids
object[]
required
Minimum array length: 1
employment_start_date
string | null
required

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
required
annual_allowance_current_year
number
required

Ignored. Kept for compatibility. Set the amounts per allowance type in defaultAllowances.

annual_allowance_next_year
number
required

Ignored. Kept for compatibility. Set the amounts per allowance type in defaultAllowances.

birthday
string | null
required

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. It is stored when it is not in the future and gives an age from 10 to 100. Other values are ignored and the member is created without a birthday.

custom_id
string | null
required
defaultAllowances
object[]
required

One entry per allowance type the member should get. An id that is not an allowance type of the workspace is rejected with 400, and so is a list that hides every allowance type of the workspace. default and disabled can be changed later via PUT /members/{member_id}/allowance-type-configurations/{allowance_type_id}.

business_phone
string | null

Business phone number. Up to 64 characters of digits, spaces and + - ( ) . /, with an optional extension (ext or x). When the e-mail address belongs to a Microsoft account of your tenant, the first profile sync replaces it with the number from Microsoft Entra ID, or removes it when Entra ID has none, and while Microsoft sync is on it cannot be changed through the API.

Maximum string length: 64

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})$