Docs
/
/
Contact supportLog inGet started
Overview
Client libraries
API keys
Authentication
Rate limits
Batch rate limits
Idempotent requests
Data retention
Bulk endpoints
Trigger data filtering
Pagination
Errors
Common error codes
Overview
Delete a tenant
Get a tenant
Set a tenant
List tenants
Get startedLog inContact support
Platform
Integrations
In-app UI
API reference
CLI reference
Management API
Developer tools
Tutorials

Set a tenant

Sets a tenant within an environment, performing an upsert operation. Any existing properties will be merged with the incoming properties.

Set a tenant

Sets a tenant within an environment, performing an upsert operation. Any existing properties will be merged with the incoming properties.

Endpoint

PUT/v1/tenants/{id}

Rate limit

Tier 3

Path parameters

id
string

The unique identifier for the tenant.

Query parameters

resolve_full_preference_settings
boolean

When true, merges environment-level default preferences into the tenant's settings.preference_set field before returning the response. Defaults to false.

Request body

channel_data
InlineChannelDataRequest

The channel data for the tenant.

name
string

An optional name for the tenant.

settings
object

The settings for the tenant. Includes branding and preference set.

branding
object

The branding for the tenant.

icon_url
string

The icon URL for the tenant. Must point to a valid image with an image MIME type.

logo_url
string

The logo URL for the tenant. Must point to a valid image with an image MIME type.

primary_color
string

The primary color for the tenant, provided as a hex value.

primary_color_contrast
string

The primary color contrast for the tenant, provided as a hex value.

preference_set
PreferenceSetRequest

The preference set for the tenant. Used to override the default preference set.

*
object(any)

Any additional custom properties.

Returns

SetTenantResponse

The response from setting a tenant.

New chat