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-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
annual_allowance_next_year
number
required
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.

custom_id
string | null
required
defaultAllowances
object[]
required

One entry per allowance type the member should get. default and disabled can be changed later via PUT /members/{member_id}/allowance-type-configurations/{allowance_type_id}.

Response

Successful response

The response is of type string<uuid>.

Pattern: ^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$