Skip to main content
POST
Create a tenant and email its first administrator a link that opens it.

Headers

Prefer
enum<string>

Preference

Available options:
params=single-object

Body

Create a tenant and email its first administrator a link that opens it.

Returns the same row api.sign_in does. Where the deployment confirms addresses, which is the default, the row carries no token and the outcome CONFIRMATION_SENT: the organisation exists but nobody can sign in to it until the link is opened with api.confirm_sign_up. Addresses at temporary-inbox services are refused as DISPOSABLE_EMAIL. Refused on a tenant's own hostname, where the form would be misleading.

p_email
string<text>
required
p_name
string<text>
required
p_organization_name
string<text>
required
p_password
string<text>
required
p_host
string<text>
p_timezone
string<text>

Response

200

OK