---
title: "Create / Update Tenants"
method: POST
path: "/v1/tenant/{tenant_id}/"
---

# Create / Update Tenants

`POST /v1/tenant/{tenant_id}/`

API to create a new Tenant OR update an existing Tenant

## Path parameters

- `tenant_id` string, required

## Request body

- object
  - `tenant_name` string, required — Name of the tenant. You can add company / organization name here
  - `logo` string — URL of the tenant logo
  - `primary_color` string — 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
  - `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
  - `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)
    - `website` string — link of tenant website. While updating a social link, if you want to remove the link, you must the value="" (instead of null)
    - `facebook` string — tenant facebook page link
    - `LinkedIn` string — tenant linkedin page link
    - `x` string — tenant x(previously twitter) page link
    - `instagram` string — tenant instagram page link
    - `medium` string — tenant medium page link
    - `discord` string — tenant discord page link
    - `telegram` string — tenant telegram page link
    - `youtube` string — tenant youtube page link
    - `tiktok` string — tenant tiktok page link
  - `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`

201 - Created

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

## Other responses

- `400` — 400 - Bad Request

---

[API](https://skmtc.net/suprsend/apis/suprsend-api.md) · [All operations](https://skmtc.net/suprsend/apis/suprsend-api/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/suprsend/suprsend-api/versions/8bd2574bd2c3/schema)