v53

OpenAPI 3.0.1raw.githubusercontent.com2026-07-31147343479.6 KB
Tenants

Create or Replace a Tenant

Creates or replaces a tenant from a name, parent, brand, properties, and default preferences supplied in the request body.

put/tenants/{tenant_id}

Path parameters

tenant_idstring required

A unique identifier representing the tenant to be returned.

Request body

namestring required

Name of the tenant.

parent_tenant_idstring nullable

Tenant's parent id (if any).

propertiesobject nullable

Arbitrary properties accessible to a template.

user_profileobject nullable

A user profile object merged with user profile on send.

brand_idstring nullable

Brand to be used for the account when one is not specified by the send call.

Response

idstring required

Id of the tenant.

namestring required

Name of the tenant.

parent_tenant_idstring nullable

Tenant's parent id (if any).

propertiesobject nullable

Arbitrary properties accessible to a template.

user_profileobject nullable

A user profile object merged with user profile on send.

brand_idstring nullable

Brand to be used for the account when one is not specified by the send call.