POST
/
v1
/
tenant
/
{tenant_id}
curl --request POST \
  --url https://hub.suprsend.com/v1/tenant/{tenant_id} \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '{
  "tenant_name": "Awesome Tenant",
  "logo": "https://ik.imagekit.io/l0quatz6utm/suprsend/staging/media/suprsend-only-logo_c8aa27faef118418e8c5bd7b31a1cafc74e09200.png",
  "primary_color": "#ff0000",
  "secondary_color": "#00ff00",
  "tertiary_color": "#0000ff",
  "preference_page_url": "<string>",
  "social_links": {
    "website": "https://suprsend.com",
    "facebook": "<string>",
    "linkedin": "<string>",
    "twitter": "<string>",
    "instagram": "<string>",
    "medium": "<string>",
    "discord": "<string>",
    "telegram": "<string>",
    "youtube": "<string>"
  },
  "properties": {}
}'
{
  "tenant_id": "brand_id",
  "tenant_name": "Awesome Tenant",
  "logo": "https://ik.imagekit.io/l0quatz6utm/suprsend/staging/media/suprsend-only-logo_c8aa27faef118418e8c5bd7b31a1cafc74e09200.png",
  "timezone": null,
  "blocked_channels": [
    "email"
  ],
  "embedded_preference_url": "https://app.suprsend.com/settings",
  "hosted_preference_domain": "preferences.suprsend.com",
  "primary_color": "#ff0000",
  "secondary_color": "#0000ff",
  "tertiary_color": "#00ffff",
  "social_links": {
    "website": "https://suprsend.com",
    "facebook": "https://www.company.com",
    "linkedin": "",
    "twitter": "",
    "instagram": "",
    "medium": "",
    "discord": "",
    "telegram": "",
    "youtube": ""
  },
  "properties": {
    "k1": "v1",
    "address": "my company address"
  },
  "updated_at": "2025-04-06T21:01:35.359787Z"
}

Authorizations

​
Authorization
string
header
required

Pass as Bearer <API_KEY>. Get API Key from SuprSend dashboard Developers -> API Keys section.

Path Parameters

​
tenant_id
string
required

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

Body

application/json
​
tenant_name
string
default:Awesome Tenant
required

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

URL of the tenant logo

​
primary_color
string
default:#ff0000

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_color
string

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

Example:

"#00ff00"

​
tertiary_color
string

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

Example:

"#0000ff"

​
preference_page_url
string

Link of the preference page inside the tenant product

​
social_links
object

urls of social media accounts of the tenant. If you really want to remove any social link, you must set its value="" (instead of null)

​
properties
object

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).

Response

201
application/json
201 - Created

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

Was this page helpful?