Skip to main content
POST
Sending an invitation

Authorizations

Authorization
string
header
required

An API key issued in the Backoffice, sent as Authorization: Bearer vzk_<key id>_<secret>. A Microsoft Entra ID access token obtained with the client credentials grant is accepted on the same header. The same value is also accepted in an X-API-Key header.

Path Parameters

language_id
string
required

Language of the email: en, nl, fr, de, … Falls back to en.

Example:

"en"

Body

application/json
_id
string
required

A 24-character hexadecimal id.

Pattern: ^[0-9a-fA-F]{24}$
Example:

"5f2a1b9c4d3e2f0011223344"

company_id
string
required

A 24-character hexadecimal id.

Pattern: ^[0-9a-fA-F]{24}$
Example:

"5f2a1b9c4d3e2f0011223344"

email
string<email>
required

Response

The invitation was queued. Empty body.