Get Variant Detail

GET

{workspace}

template

{template_slug}

channel

{channel}

variant

{variant_id}

Get Variant

curl -X GET "https://management-api.suprsend.com/v2/{workspace}/template/{template_slug}/channel/{channel}/variant/{variant_id}/" \
  --header 'Authorization: ServiceToken <token>'

import requests

url = "https://management-api.suprsend.com/v2/{workspace}/template/{template_slug}/channel/{channel}/variant/{variant_id}/"

headers = {"ServiceToken <token>": "<api-key>"}

response = requests.get(url, headers=headers)

print(response.text)

const options = {method: 'GET', headers: {'ServiceToken <token>': '<api-key>'}};

fetch('https://management-api.suprsend.com/v2/{workspace}/template/{template_slug}/channel/{channel}/variant/{variant_id}/', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://management-api.suprsend.com/v2/{workspace}/template/{template_slug}/channel/{channel}/variant/{variant_id}/",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "GET",
  CURLOPT_HTTPHEADER => [
    "ServiceToken <token>: <api-key>"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"net/http"
	"io"
)

func main() {

	url := "https://management-api.suprsend.com/v2/{workspace}/template/{template_slug}/channel/{channel}/variant/{variant_id}/"

	req, _ := http.NewRequest("GET", url, nil)

	req.Header.Add("ServiceToken <token>", "<api-key>")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

HttpResponse<String> response = Unirest.get("https://management-api.suprsend.com/v2/{workspace}/template/{template_slug}/channel/{channel}/variant/{variant_id}/")
  .header("ServiceToken <token>", "<api-key>")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://management-api.suprsend.com/v2/{workspace}/template/{template_slug}/channel/{channel}/variant/{variant_id}/")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Get.new(url)
request["ServiceToken <token>"] = '<api-key>'

response = http.request(request)
puts response.read_body

{
  "$schema": "https://schema.suprsend.com/template/v2/variant_schema.json",
  "channel": "email",
  "id": "default",
  "tenant_id": null,
  "locale": "en",
  "conditions": [],
  "hash": "dd176370a4b99c735e30f70bc98c61983671072c40db70750c3ada9e5edcabc1",
  "needs_vendor_approval": false,
  "sysgen_template_name": null,
  "approval_status": "auto_approved",
  "discard_comment": null,
  "approval_at": "2026-04-07T10:39:28.502737Z",
  "content": {
    "$schema": "https://schema.suprsend.com/template/v2/channel/email_schema.json",
    "templating_language": "handlebars",
    "from_name": "Acme Store",
    "from_address": "noreply@acme-store.com",
    "extra_to": "",
    "cc": "",
    "bcc": "",
    "reply_to": "",
    "subject": "Order Confirmed - #{{order.number}}",
    "body": {
      "type": "raw",
      "raw": {
        "html": "<html><body><h1>Order Confirmed!</h1><p>Hi {{customer.name}}, your order #{{order.number}} has been confirmed.</p><p>Total: {{order.total}}</p></body></html>",
        "text": "Hi {{customer.name}}, your order #{{order.number}} has been confirmed. Total: {{order.total}}"
      },
      "designer": {
        "html": "...",
        "text": "...",
        "design_json": {},
        "display_conditions": []
      },
      "preheader": "Your order #{{order.number}} is confirmed",
      "plain_text": null,
      "email_markup": ""
    }
  },
  "errors": {},
  "vendor_approvals": [],
  "has_error": false,
  "seq_no": 1,
  "action": null,
  "created_at": "2026-04-07T10:39:28.510000Z"
}

{
  "code": 401,
  "error_code": "authentication_failed",
  "type": "AuthenticationFailed",
  "message": "Invalid service token.",
  "detail": "Invalid service token."
}

{
  "code": 404,
  "error_code": "not_found",
  "type": "NotFound",
  "message": "workspace 'demo' not found",
  "detail": "workspace 'demo' not found"
}

Authorizations

ServiceToken <token>

string

header

required

You can get Service Token from SuprSend dashboard -> Account Settings -> Service Tokens section.

Path Parameters

workspace

string

required

template_slug

string

required

channel

enum<string>

required

Available options:

email,

sms,

whatsapp,

inbox,

androidpush,

iospush,

webpush,

slack,

ms_teams

variant_id

string

required

Variant identifier.

Response

Variant details retrieved. Includes full content and vendor_approvals objects.

$schema

string

Schema URL for variant validation.

Example:

"https://schema.suprsend.com/template/v2/variant_schema.json"

channel

string

Channel this variant belongs to.

Example:

"email"

string

Variant identifier.

Example:

"default"

tenant_id

string | null

Tenant this variant is scoped to, or null for default.

locale

string

Locale code.

Example:

"en"

conditions

object[]

Conditions for variant selection at send time.

hash

string

Content hash for change detection.

needs_vendor_approval

boolean

Whether this variant requires vendor approval (SMS DLT, WhatsApp).

sysgen_template_name

string | null

System-generated template name for vendor approval.

approval_status

enum<string>

Current approval status of the variant.

Available options:

auto_approved,

pending,

sent_for_approval,

approved,

rejected

discard_comment

string | null

Reason provided when a variant is discarded.

approval_at

string<date-time> | null

Timestamp when the variant was approved.

has_error

boolean

Whether the variant has validation errors.

seq_no

integer

Ordering within the channel + tenant + locale combination.

action

string | null

Action taken in the latest commit (Updated, Added, Unchanged, or null).

created_at

string<date-time>

Timestamp when the variant was created.

content

object

Channel-specific content. Structure varies by channel. Only returned in variant detail endpoint.

vendor_approvals

object[]

Vendor approval entries (WhatsApp/SMS only). Only returned in variant detail endpoint.

Create/Update VariantCreate a new variant or update an existing one for a specific channel. Pass the variant content, conditions, locale, and optionally vendor approval details. The `content` JSON structure is channel-specific. Refer to the [variant content schema](https://schema.suprsend.com/template/v2/variant_schema.json) for each channel's structure.

⌘I

Get Variant

curl -X GET "https://management-api.suprsend.com/v2/{workspace}/template/{template_slug}/channel/{channel}/variant/{variant_id}/" \
  --header 'Authorization: ServiceToken <token>'

import requests

url = "https://management-api.suprsend.com/v2/{workspace}/template/{template_slug}/channel/{channel}/variant/{variant_id}/"

headers = {"ServiceToken <token>": "<api-key>"}

response = requests.get(url, headers=headers)

print(response.text)

const options = {method: 'GET', headers: {'ServiceToken <token>': '<api-key>'}};

fetch('https://management-api.suprsend.com/v2/{workspace}/template/{template_slug}/channel/{channel}/variant/{variant_id}/', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://management-api.suprsend.com/v2/{workspace}/template/{template_slug}/channel/{channel}/variant/{variant_id}/",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "GET",
  CURLOPT_HTTPHEADER => [
    "ServiceToken <token>: <api-key>"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"net/http"
	"io"
)

func main() {

	url := "https://management-api.suprsend.com/v2/{workspace}/template/{template_slug}/channel/{channel}/variant/{variant_id}/"

	req, _ := http.NewRequest("GET", url, nil)

	req.Header.Add("ServiceToken <token>", "<api-key>")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

HttpResponse<String> response = Unirest.get("https://management-api.suprsend.com/v2/{workspace}/template/{template_slug}/channel/{channel}/variant/{variant_id}/")
  .header("ServiceToken <token>", "<api-key>")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://management-api.suprsend.com/v2/{workspace}/template/{template_slug}/channel/{channel}/variant/{variant_id}/")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Get.new(url)
request["ServiceToken <token>"] = '<api-key>'

response = http.request(request)
puts response.read_body

{
  "$schema": "https://schema.suprsend.com/template/v2/variant_schema.json",
  "channel": "email",
  "id": "default",
  "tenant_id": null,
  "locale": "en",
  "conditions": [],
  "hash": "dd176370a4b99c735e30f70bc98c61983671072c40db70750c3ada9e5edcabc1",
  "needs_vendor_approval": false,
  "sysgen_template_name": null,
  "approval_status": "auto_approved",
  "discard_comment": null,
  "approval_at": "2026-04-07T10:39:28.502737Z",
  "content": {
    "$schema": "https://schema.suprsend.com/template/v2/channel/email_schema.json",
    "templating_language": "handlebars",
    "from_name": "Acme Store",
    "from_address": "noreply@acme-store.com",
    "extra_to": "",
    "cc": "",
    "bcc": "",
    "reply_to": "",
    "subject": "Order Confirmed - #{{order.number}}",
    "body": {
      "type": "raw",
      "raw": {
        "html": "<html><body><h1>Order Confirmed!</h1><p>Hi {{customer.name}}, your order #{{order.number}} has been confirmed.</p><p>Total: {{order.total}}</p></body></html>",
        "text": "Hi {{customer.name}}, your order #{{order.number}} has been confirmed. Total: {{order.total}}"
      },
      "designer": {
        "html": "...",
        "text": "...",
        "design_json": {},
        "display_conditions": []
      },
      "preheader": "Your order #{{order.number}} is confirmed",
      "plain_text": null,
      "email_markup": ""
    }
  },
  "errors": {},
  "vendor_approvals": [],
  "has_error": false,
  "seq_no": 1,
  "action": null,
  "created_at": "2026-04-07T10:39:28.510000Z"
}

{
  "code": 401,
  "error_code": "authentication_failed",
  "type": "AuthenticationFailed",
  "message": "Invalid service token.",
  "detail": "Invalid service token."
}

{
  "code": 404,
  "error_code": "not_found",
  "type": "NotFound",
  "message": "workspace 'demo' not found",
  "detail": "workspace 'demo' not found"
}

API Reference

WORKSPACE & AUTH KEYS

WORKFLOWS

SCHEMAS

EVENTS

CATEGORIES

TRANSLATIONS

TEMPLATES

Authorizations

Path Parameters

Response