Quickstart - SuprSend, Notification infrastructure for Product teams

This guide walks through creating a tenant, using tenant data in templates, and triggering a notification with tenant context.

Step 1: Create a Tenant

MCP
Backend Code
SuprSend UI

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.

curl --request POST \
     --url https://hub.suprsend.com/v1/tenant/acme-corp \
     --header 'Authorization: Bearer __api_key__' \
     --header 'accept: application/json' \
     --header 'content-type: application/json' \
     --data '{
  "tenant_name": "Acme Corp",
  "logo": "https://acme.com/logo.png",
  "primary_color": "#0055ff",
  "social_links": {
    "website": "https://acme.com"
  }
}'

from suprsend import Suprsend

supr_client = Suprsend("workspace_key", "workspace_secret")

response = supr_client.tenants.upsert("acme-corp", {
    "tenant_name": "Acme Corp",
    "logo": "https://acme.com/logo.png",
    "primary_color": "#0055ff",
    "social_links": {
        "website": "https://acme.com"
    }
})
print(response)

const { Suprsend } = require("@suprsend/node-sdk");

const supr_client = new Suprsend("workspace_key", "workspace_secret");

const response = supr_client.tenants.upsert("acme-corp", {
    tenant_name: "Acme Corp",
    logo: "https://acme.com/logo.png",
    primary_color: "#0055ff",
    social_links: {
        website: "https://acme.com"
    }
});
response.then((res) => console.log(res));

import org.json.JSONObject;

import suprsend.Suprsend;
import suprsend.SuprsendAPIException;

Suprsend suprsendClient = new Suprsend("workspace_key", "workspace_secret");

JSONObject payload = new JSONObject()
    .put("tenant_name", "Acme Corp")
    .put("logo", "https://acme.com/logo.png")
    .put("primary_color", "#0055ff")
    .put("social_links", new JSONObject()
        .put("website", "https://acme.com")
    )
;

JSONObject response = suprsendClient.tenants.upsert("acme-corp", payload);
System.out.println(response);

suprClient, _ := suprsend.NewClient("workspace_key", "workspace_secret")

tenantPayload := &suprsend.Tenant{
    TenantName:   suprsend.String("Acme Corp"),
    Logo:         suprsend.String("https://acme.com/logo.png"),
    PrimaryColor: suprsend.String("#0055ff"),
}

res, err := suprClient.Tenants.Upsert(context.Background(), "acme-corp", tenantPayload)
if err != nil {
    log.Fatalln(err)
}
log.Println(res)

upsert creates the tenant if it doesn’t exist, or updates it if it does. The Tenant ID cannot be changed after creation.

Step 2: Customize tenant templates

Open any template in the template editor. Tenant variables follow the format $brand.<property> and are replaced at send time based on the tenant_id you pass.

Customizing header, footer, and buttons in email templates

You can use the built-in Tenant block in email designer to automatically get the branded header, footer, and buttons for a tenant. For any other customization, pass tenant variable as $brand.<property> in the template.

Inserting tenant variables

Type { in email editor or {{ in other channels to see tenant variables in auto-suggestions. Here’s an example email template:

Email template

<h2>Hello from {{$brand.brand_name}}!</h2>
<p>Your account is now active. Visit us at {{$brand.social_links.website}}.</p>
<p style="color: {{$brand.primary_color}};">We're glad to have you.</p>

When triggered with tenant_id="acme-corp", the variables resolve to Acme Corp’s actual values.

Show/Hide template content based on tenant properties

Use custom properties to conditionally show content for specific tenants. Set a property (for example, pricing_type: free) on the tenant, then basis that, show upgrade banner in the template. In email template, you can use display condition to show/hide the content based on the property.

Inbox template

{{#compare $brand.properties.pricing_type '==' "free"}}
  🎉 You're on a free trial - [upgrade now]({{$brand.properties.upgrade_url}})
{{/compare}}

Step 3: Trigger a Workflow with tenant_id

Pass tenant_id when triggering a workflow. SuprSend applies the matching tenant’s branding and preferences automatically.

curl --request POST \
     --url https://hub.suprsend.com/trigger/ \
     --header 'Authorization: Bearer __api_key__' \
     --header 'content-type: application/json' \
     --data '{"workflow": "welcome_email", "recipients": [...], "tenant_id": "acme-corp"}'

w1 = WorkflowTriggerRequest(body={...}, tenant_id="acme-corp")
supr_client.workflows.trigger(w1)

const w1 = new WorkflowTriggerRequest(body, { tenant_id: "acme-corp" });
supr_client.workflows.trigger(w1);

WorkflowTriggerRequest wf = new WorkflowTriggerRequest(body, "acme-corp");
suprClient.workflows.trigger(wf);

w1 := &suprsend.WorkflowTriggerRequest{Body: body, TenantId: "acme-corp"}
suprClient.Workflows.Trigger(w1)

SuprSend resolves all $tenant.* and $brand.* variables using the properties of acme-corp before sending.

​Step 1: Create a Tenant

​Step 2: Customize tenant templates

​Customizing header, footer, and buttons in email templates

​Inserting tenant variables

​Show/Hide template content based on tenant properties

​Step 3: Trigger a Workflow with tenant_id

Step 1: Create a Tenant

Step 2: Customize tenant templates

Customizing header, footer, and buttons in email templates

Inserting tenant variables

Show/Hide template content based on tenant properties

Step 3: Trigger a Workflow with tenant_id