USERS
EVENTS
OBJECTS
PREFERENCE
- Update User Preferences
- Get User Preferences
- Manage Tenant Preferences
- Update Object Preferences
- Get Object Preferences
LISTS
BROADCAST
TENANTS
Create / Update Tenants
API to create a new Tenant OR update an existing Tenant
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
Pass as Bearer <API_KEY>
. Get API Key from SuprSend dashboard Developers -> API Keys section.
Path Parameters
unique identifier of the tenant that you want to create / update
Body
application/json
Response
201
application/json
201 - Created
Updated Object Payload is returned in response. JSON structure similar to request payload.
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"
}
Assistant
Responses are generated using AI and may contain mistakes.