Create / Update Tenants
API to create a new Tenant OR update an existing Tenant
Authorizations
Pass as Bearer <API_KEY>. Get API Key from SuprSend dashboard Developers -> API Keys section.
Path Parameters
Tenant identifier to create or update. Max 64 chars; allowed characters [a-zA-Z0-9_.-] (converted to lowercase unless case-sensitive IDs are enabled for your organization).
64^[a-zA-Z0-9_.-]+$Body
Tenant display name. Replaces the legacy tenant_name field; both are accepted.
Will be deprecated in future. Use name instead.
ID of the parent tenant if you want to add this tenant as a sub-tenant. Skip this field, or pass null or "" to create the tenant as a root. Setting it on an existing tenant re-parents it or leave it null to delink existing parent. Must reference an existing tenant. See Sub-tenants.
"acme-corp"
Channels turned off for this tenant. Notifications on these channels won't be sent to any user of the tenant — including on root categories (which users normally can't unsubscribe from) — and users can't override this. If sub-tenants are used, a block set here also applies to every sub-tenant below and can't be removed lower down. Allowed: email, sms, whatsapp, androidpush, iospush, webpush, slack, ms_teams, inbox.
Tenant logo URL.
Primary brand color, used in the tenant's email header, buttons, and footer. If left empty when creating a root tenant, it's set to SuprSend's default (#777777).
Secondary brand color. Not part of the default tenant component but can be used in templates as {{$tenant.secondary_color}}. If both secondary and tertiary colors are left empty when creating a root tenant, they're copied from the default tenant.
"#00ff00"
Tertiary brand color. Not part of the default tenant component but can be used in templates as {{$tenant.tertiary_color}}. If both secondary and tertiary colors are left empty when creating a root tenant, they're copied from the default tenant.
"#0000ff"
URL of your product's preference page.
Tenant's social media URLs. Pass "" to clear a link (not null).
Custom tenant properties. Merged per top-level key on update — keys not in the payload are kept as-is.
Response
201 - Created
Tenant object returned. Fields hold the tenant's own local values — values not set on this tenant come back as null (or as empty objects/arrays). For flat tenants (no sub-tenants), unset fields stay unresolved and the tenant simply has no value for them. For sub-tenants, unset fields still return null here, but are resolved from the closest ancestor that has a value set at trigger time.