Skip to main content

​
Creating a Tenant

With the SuprSend MCP server configured in your AI assistant (Claude, Cursor, etc.), just pass a simple prompt to create tenant:
Create a tenant in staging workspace for my company with ID - `<company_id>`, pick name, logo, colors and social links from my website - `<website_url>`
The MCP server calls the upsert_suprsend_tenant tool under the hood to create the tenant.

​
Tenant Properties

FieldTypeDescriptionVariable Syntax
Tenant IDstring (max 64 chars)Unique identifier. Allowed: lowercase letters, numbers, hyphens, underscores ([a-z0-9_-]). Map to customer ID from your system. Cannot be changed after creation
Tenant NamestringCompany or organization name$tenant.brand_name (in workflow) / $brand.brand_name (in template)
Logoimage url (.png, .jpg, .jpeg)Logo displayed in email header$tenant.logo
Primary Colorhex codeUsed in buttons, headers, footer borders. Must be HEX values (e.g., #ff0000). Falls back to default if not set$tenant.primary_color (in workflow) / $brand.primary_color (in template)
Secondary Colorhex codeAdditional color for customization. Must be HEX values (e.g., #ff0000)$tenant.secondary_color (in workflow) / $brand.secondary_color (in template)
Tertiary Colorhex codeAdditional color for customization. Must be HEX values (e.g., #ff0000)$tenant.tertiary_color (in workflow) / $brand.tertiary_color (in template)
Social LinksURLSocial media URLs. Displayed in email footer$tenant.social_links.website (in workflow) / $brand.social_links.website (in template)
Embedded Preference PageURLUnsubscribe page URL auto generated by SuprSend$tenant.embedded_preference_url (in workflow) / $brand.embedded_preference_url (in template)
Hosted Preference DomainURLPreference page URL embedded inside your product to capture user preferences$tenant.hosted_preference_domain (in workflow) / $brand.hosted_preference_domain (in template)
Custom PropertiesJSONCustom JSON metadata accessible via SDKs and APIs. Not directly available in templates. Ideal for storing metadata required for backend logic$tenant.properties.<key> (in workflow) / $brand.properties.<key> (in template)

​
Managing Existing Tenants

Go to Tenants from the side navigation, then click on any tenant to view and edit its details from UI. Use below methods to manage tenants programmatically.

​
View a Tenant

curl --request GET \
     --url 'https://hub.suprsend.com/v1/tenant/{tenant_id}' \
     --header 'Authorization: Bearer __api_key__' \
     --header 'accept: application/json'

​
List Tenants

curl --request GET \
     --url 'https://hub.suprsend.com/v1/tenant/?limit=20&offset=0' \
     --header 'Authorization: Bearer __api_key__' \
     --header 'accept: application/json'

​
Update a Tenant

curl --request POST \
     --url https://hub.suprsend.com/v1/tenant/{tenant_id} \
     --header 'Authorization: Bearer __api_key__' \
     --header 'accept: application/json' \
     --header 'content-type: application/json' \
     --data '{
  "tenant_name": "Updated Company Name",
  "primary_color": "#00ff00"
}'
Tenant ID cannot be changed after creation.

​
Delete a Tenant

Deleting a tenant is irreversible and removes all associated properties. It does not delete historical notification logs.
curl --request DELETE \
     --url https://hub.suprsend.com/v1/tenant/{tenant_id} \
     --header 'Authorization: Bearer __api_key__' \
     --header 'accept: application/json'

​
Next Steps