API Reference

Create invitation

post
https://tenants-gateway-api-sbx.sidedrawersbx.com/api/v1/tenants/tenant/tenant-id//users/invitations
Path Params
string
required

Tenant identifier.

Body Params
string

Contributor's first name.

string

Contributor's last name.

string
required

Contributor email.

string

Country of residence.

string

Business name.

number

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

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

The Invitation code to the entity.

string

This is only applicable for enterprise implementations. The federationId identifies the institution.

string

Region to store the data.

string

Email template.

boolean
Defaults to false

Skip delivery.

notificationKeys
array of objects

Array of notification key-value pairs for dynamic template replacement. These keys will be merged with standard template parameters and can be used in mustache templates like {{businessName}}, {{appointmentDate}}, etc.

notificationKeys
string
enum

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

Allowed:
Response

Updated 10 months ago

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

Updated 10 months ago

Did this page help you?