Sign in

v2

latestOpenAPI 3.1.12026-07-2613060964.2 KB

Get Variant Detail

Retrieve detailed information about a specific variant including its content, conditions, and vendor approval status.

get/v2/{workspace}/template/{template_slug}/channel/{channel}/variant/{variant_id}/

Path parameters

workspacestring required
template_slugstring required
channel'email' | 'sms' | 'whatsapp' | 'inbox' | 'androidpush' | 'iospush' | 'webpush' | 'slack' | 'ms_teams' required
variant_idstring required

Variant identifier.

Response

Variant details retrieved. Includes full content and vendor_approvals objects.

$schemastring

Schema URL for variant validation.

channelstring

Channel this variant belongs to.

idstring

Variant identifier.

tenant_idstring nullable

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

localestring

Locale code.

conditionsobject[]

Conditions for variant selection at send time.

hashstring

Content hash for change detection.

needs_vendor_approvalboolean

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

sysgen_template_namestring nullable

System-generated template name for vendor approval.

approval_status'auto_approved' | 'pending' | 'sent_for_approval' | 'approved' | 'rejected'

Current approval status of the variant.

discard_commentstring nullable

Reason provided when a variant is discarded.

approval_atstring date-time nullable

Timestamp when the variant was approved.

has_errorboolean

Whether the variant has validation errors.

seq_nointeger

Ordering within the channel + tenant + locale combination.

actionstring nullable

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

created_atstring date-time

Timestamp when the variant was created.

contentobject

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

vendor_approvalsobject[]

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

Example response

{
  "$schema": "https://schema.suprsend.com/template/v2/variant_schema.json",
  "channel": "email",
  "id": "default",
  "locale": "en"
}