Sign in

v2

latestOpenAPI 3.1.12026-07-2613060964.2 KB

Create / Update Tenants

API to create a new Tenant OR update an existing Tenant

post/v1/tenant/{tenant_id}/

Path parameters

tenant_idstring required

unique identifier of the tenant that you want to create / update

Request body

tenant_namestring required

Name of the tenant. You can add company / organization name here

logostring

URL of the tenant logo

primary_colorstring

Primary color of the tenant - used for designing tenant template. If you don't provide any of the colors for the tenant, SuprSend will assume you want to use the default values, so color settings will automatically be set to the color settings of default tenant.

secondary_colorstring

Secondary color of the tenant - not used for designing the default templates. You can however add this property and use it in your templates

tertiary_colorstring

Tertiary color of the tenant - not used for designing the default templates. You can however add this property and use it in your templates

preference_page_urlstring

Link of the preference page inside the tenant product

propertiesobject

Custom properties associated with the tenant. Update operation on properties works like upsert on 1st-level keys (i.e., if top-level key doesn't already exist, then it will be added, otherwise its value will be replaced by the new value. All other key-value pairs will remain unchanged).

Example request

{
  "secondary_color": "#00ff00",
  "tertiary_color": "#0000ff"
}

Response

201 - Created

object required

Updated Object Payload is returned in response. JSON structure similar to request payload.