Tenant

Your system's identifier for this tenant, set when the tenant was created via the API or an integration. Use this to map back to the corresponding record in your own database.

An optional URL linking to the tenant in your own product or admin panel.

Indicates how this tenant was created: directly via the API, synced from Salesforce, or synced from HubSpot.

The support tier assigned to this tenant, used to apply SLAs and prioritisation rules to threads belonging to this tenant.

Slack (or other channel) associations configured for this tenant, used to route new threads to the appropriate channel automatically.

Custom field values stored on this tenant, corresponding to the workspace's tenant field schemas.

The primary domain name associated with this tenant (e.g. acme.com).

Alternate domain names associated with this tenant.

URL of the tenant's logo image. Pass an optional size argument (pixels) to request a resized version. Null if no logo is set.

Whether customers whose email domain matches this tenant's primary or alternate domains are automatically added to it.