Create invitation

Path Params
string
required

Tenant identifier.

string
required

The Invitation code to the entity.

Body Params
string

Contributor's first name.

string

Contributor's last name.

string
required

Contributor email.

number
≥ 0

Phone number (numeric format only). Must be a positive integer. When provided without phoneExt, phoneExt defaults to 1. Example: 5551234567 for US number, 447123456789 for UK number.

number
≥ 0

Phone extension/country code (numeric format only). Must be a positive integer. Defaults to 1 when phoneNumber is provided but phoneExt is missing. Ignored if phoneNumber is not provided. Common values: 1 (US/Canada), 44 (UK), 33 (France), 49 (Germany).

string
required

The affiliate code (brandCode) is an identifier for the "brand" or "affiliate" within a Tenant. The affiliate code is the version of the brand name that appears in the URL. A brand name may be "Corporate ABC", for example. Then the affiliate code might be something like "corporate-abc".

string

Business name.

string

Country of residence.

string

Email template.

notificationKeys
array of arrays

Array of notification keys for dynamic template values.

notificationKeys
string
enum

Locale in [ISO 639-1]-[ISO 3166-1] format.

Allowed:
Response

Language
Credentials
Bearer
JWT
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json