Tenants

Create or Replace a Tenant

PUT

Path parameters

tenant_idstringRequired
A unique identifier representing the tenant to be returned.

Request

This endpoint expects an object.
name
stringRequired
Name of the tenant.
parent_tenant_id
stringOptional
Tenant's parent id (if any).
default_preferences
objectOptional
Defines the preferences used for the tenant when the user hasn't specified their own.
properties
map from strings to anyOptional
Arbitrary properties accessible to a template.
user_profile
map from strings to anyOptional
A user profile object merged with user profile on send.
brand_id
stringOptional
Brand to be used for the account when one is not specified by the send call.

Response

This endpoint returns an object
id
string
Id of the tenant.
name
string
Name of the tenant.
parent_tenant_id
stringOptional
Tenant's parent id (if any).
default_preferences
objectOptional
Defines the preferences used for the account when the user hasn't specified their own.
properties
map from strings to anyOptional
Arbitrary properties accessible to a template.
user_profile
map from strings to anyOptional
A user profile object merged with user profile on send.
brand_id
stringOptional
Brand to be used for the account when one is not specified by the send call.