Add/Update Vendor Approval

PATCH

{workspace}

template

{template_slug}

channel

{channel}

variant

{variant_id}

vendor_approval

Approve Variant

curl -X PATCH "https://management-api.suprsend.com/v2/{workspace}/template/{template_slug}/channel/{channel}/variant/{variant_id}/vendor_approval/?mode=live" \
  --header 'Authorization: ServiceToken <token>' \
  --header 'Content-Type: application/json' \
  --data '{
    "approval_status": "approved",
    "vendor_slug": "twilio-whatsapp",
    "vendor_uid": "waba_id-123221",
    "vendor_template_name": "tpl_v12",
    "vendor_template_id": "1232",
    "vendor_locale_code": "en",
    "vendor_template_category": "UTILITY"
  }'

import requests

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

payload = {
    "approval_status": "approved",
    "vendor_slug": "twilio-whatsapp",
    "vendor_uid": "waba_id-123221",
    "vendor_template_name": "tpl_v12",
    "vendor_template_id": "1232",
    "vendor_locale_code": "en",
    "vendor_template_category": "UTILITY",
    "provider_template_id": "<string>",
    "comment": "<string>"
}
headers = {
    "Authorization": "<api-key>",
    "Content-Type": "application/json"
}

response = requests.patch(url, json=payload, headers=headers)

print(response.text)

const options = {
  method: 'PATCH',
  headers: {Authorization: '<api-key>', 'Content-Type': 'application/json'},
  body: JSON.stringify({
    approval_status: 'approved',
    vendor_slug: 'twilio-whatsapp',
    vendor_uid: 'waba_id-123221',
    vendor_template_name: 'tpl_v12',
    vendor_template_id: '1232',
    vendor_locale_code: 'en',
    vendor_template_category: 'UTILITY',
    provider_template_id: '<string>',
    comment: '<string>'
  })
};

fetch('https://management-api.suprsend.com/v2/{workspace}/template/{template_slug}/channel/{channel}/variant/{variant_id}/vendor_approval/', 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}/vendor_approval/",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "PATCH",
  CURLOPT_POSTFIELDS => json_encode([
    'approval_status' => 'approved',
    'vendor_slug' => 'twilio-whatsapp',
    'vendor_uid' => 'waba_id-123221',
    'vendor_template_name' => 'tpl_v12',
    'vendor_template_id' => '1232',
    'vendor_locale_code' => 'en',
    'vendor_template_category' => 'UTILITY',
    'provider_template_id' => '<string>',
    'comment' => '<string>'
  ]),
  CURLOPT_HTTPHEADER => [
    "Authorization: <api-key>",
    "Content-Type: application/json"
  ],
]);

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

curl_close($curl);

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

package main

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

func main() {

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

	payload := strings.NewReader("{\n  \"approval_status\": \"approved\",\n  \"vendor_slug\": \"twilio-whatsapp\",\n  \"vendor_uid\": \"waba_id-123221\",\n  \"vendor_template_name\": \"tpl_v12\",\n  \"vendor_template_id\": \"1232\",\n  \"vendor_locale_code\": \"en\",\n  \"vendor_template_category\": \"UTILITY\",\n  \"provider_template_id\": \"<string>\",\n  \"comment\": \"<string>\"\n}")

	req, _ := http.NewRequest("PATCH", url, payload)

	req.Header.Add("Authorization", "<api-key>")
	req.Header.Add("Content-Type", "application/json")

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

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

	fmt.Println(string(body))

}

HttpResponse<String> response = Unirest.patch("https://management-api.suprsend.com/v2/{workspace}/template/{template_slug}/channel/{channel}/variant/{variant_id}/vendor_approval/")
  .header("Authorization", "<api-key>")
  .header("Content-Type", "application/json")
  .body("{\n  \"approval_status\": \"approved\",\n  \"vendor_slug\": \"twilio-whatsapp\",\n  \"vendor_uid\": \"waba_id-123221\",\n  \"vendor_template_name\": \"tpl_v12\",\n  \"vendor_template_id\": \"1232\",\n  \"vendor_locale_code\": \"en\",\n  \"vendor_template_category\": \"UTILITY\",\n  \"provider_template_id\": \"<string>\",\n  \"comment\": \"<string>\"\n}")
  .asString();

require 'uri'
require 'net/http'

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

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

request = Net::HTTP::Patch.new(url)
request["Authorization"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"approval_status\": \"approved\",\n  \"vendor_slug\": \"twilio-whatsapp\",\n  \"vendor_uid\": \"waba_id-123221\",\n  \"vendor_template_name\": \"tpl_v12\",\n  \"vendor_template_id\": \"1232\",\n  \"vendor_locale_code\": \"en\",\n  \"vendor_template_category\": \"UTILITY\",\n  \"provider_template_id\": \"<string>\",\n  \"comment\": \"<string>\"\n}"

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

{
  "$schema": "https://schema.suprsend.com/template/v2/variant_schema.json",
  "channel": "email",
  "id": "default",
  "tenant_id": "<string>",
  "locale": "en",
  "conditions": [
    {}
  ],
  "hash": "<string>",
  "needs_vendor_approval": true,
  "sysgen_template_name": "<string>",
  "approval_status": "auto_approved",
  "discard_comment": "<string>",
  "approval_at": "2023-11-07T05:31:56Z",
  "has_error": true,
  "seq_no": 123,
  "action": "added",
  "created_at": "2023-11-07T05:31:56Z",
  "content": {},
  "vendor_approvals": [
    {}
  ]
}

{
  "code": 400,
  "error_code": "error",
  "type": "ValidationError",
  "message": "[\"cannot update variant approval-status in draft version\"]",
  "detail": [
    "cannot update variant approval-status in draft version"
  ]
}

{
  "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

Authorization

string

header

required

Pass as Authorization: ServiceToken <token>. 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:

whatsapp,

sms

variant_id

string

required

Query Parameters

mode

enum<string>

required

Must be live. Approval actions apply to the live version only; if omitted the API defaults to draft and rejects the request.

Available options:

live

Body

application/json

approval_status

enum<string>

required

Current approval status.

Available options:

pending,

sent_for_approval,

approved,

rejected

Example:

"approved"

vendor_slug

string

required

Slug of the vendor (e.g., twilio-whatsapp, gupshup-whatsapp, msg91-sms).

Example:

"twilio-whatsapp"

vendor_uid

string

required

Unique vendor identifier (e.g., WABA ID for WhatsApp).

Example:

"waba_id-123221"

vendor_template_name

string

required

Template name as registered at the vendor portal. Lowercase letters, numbers and underscores only.

Example:

"tpl_v12"

vendor_template_id

string

(Required if approved) Template ID from the vendor portal.

Example:

"1232"

vendor_locale_code

string

(Required for WhatsApp if approved) Locale code at the vendor end.

Example:

"en"

vendor_template_category

enum<string>

(Required for WhatsApp if approved) Template category at the vendor end.

Available options:

UTILITY,

MARKETING,

AUTHENTICATION

Example:

"UTILITY"

provider_template_id

string

(Required for SMS when vendor_slug is msg91-sms) Provider-level template ID.

comment

string

(Required if rejected) Reason for rejection.

Response

Vendor approval entry updated. Returns the updated variant.

$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,

discarded,

upload_failed

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

enum<string> | null

Action taken in the latest commit (added, updated, unchanged, deleted, or null in draft).

Available options:

added,

updated,

unchanged,

deleted

created_at

string<date-time>

Timestamp when the variant was created.

content

object

Channel-specific content. Structure varies by channel. Returned by the variant detail endpoint, and by the variant list endpoints only when include_content=true is passed.

vendor_approvals

object[]

Vendor approval entries (WhatsApp/SMS only). Returned by the variant detail endpoint, and by the variant list endpoints only when include_content=true is passed.

⌘I

Approve Variant

curl -X PATCH "https://management-api.suprsend.com/v2/{workspace}/template/{template_slug}/channel/{channel}/variant/{variant_id}/vendor_approval/?mode=live" \
  --header 'Authorization: ServiceToken <token>' \
  --header 'Content-Type: application/json' \
  --data '{
    "approval_status": "approved",
    "vendor_slug": "twilio-whatsapp",
    "vendor_uid": "waba_id-123221",
    "vendor_template_name": "tpl_v12",
    "vendor_template_id": "1232",
    "vendor_locale_code": "en",
    "vendor_template_category": "UTILITY"
  }'

import requests

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

payload = {
    "approval_status": "approved",
    "vendor_slug": "twilio-whatsapp",
    "vendor_uid": "waba_id-123221",
    "vendor_template_name": "tpl_v12",
    "vendor_template_id": "1232",
    "vendor_locale_code": "en",
    "vendor_template_category": "UTILITY",
    "provider_template_id": "<string>",
    "comment": "<string>"
}
headers = {
    "Authorization": "<api-key>",
    "Content-Type": "application/json"
}

response = requests.patch(url, json=payload, headers=headers)

print(response.text)

const options = {
  method: 'PATCH',
  headers: {Authorization: '<api-key>', 'Content-Type': 'application/json'},
  body: JSON.stringify({
    approval_status: 'approved',
    vendor_slug: 'twilio-whatsapp',
    vendor_uid: 'waba_id-123221',
    vendor_template_name: 'tpl_v12',
    vendor_template_id: '1232',
    vendor_locale_code: 'en',
    vendor_template_category: 'UTILITY',
    provider_template_id: '<string>',
    comment: '<string>'
  })
};

fetch('https://management-api.suprsend.com/v2/{workspace}/template/{template_slug}/channel/{channel}/variant/{variant_id}/vendor_approval/', 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}/vendor_approval/",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "PATCH",
  CURLOPT_POSTFIELDS => json_encode([
    'approval_status' => 'approved',
    'vendor_slug' => 'twilio-whatsapp',
    'vendor_uid' => 'waba_id-123221',
    'vendor_template_name' => 'tpl_v12',
    'vendor_template_id' => '1232',
    'vendor_locale_code' => 'en',
    'vendor_template_category' => 'UTILITY',
    'provider_template_id' => '<string>',
    'comment' => '<string>'
  ]),
  CURLOPT_HTTPHEADER => [
    "Authorization: <api-key>",
    "Content-Type: application/json"
  ],
]);

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

curl_close($curl);

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

package main

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

func main() {

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

	payload := strings.NewReader("{\n  \"approval_status\": \"approved\",\n  \"vendor_slug\": \"twilio-whatsapp\",\n  \"vendor_uid\": \"waba_id-123221\",\n  \"vendor_template_name\": \"tpl_v12\",\n  \"vendor_template_id\": \"1232\",\n  \"vendor_locale_code\": \"en\",\n  \"vendor_template_category\": \"UTILITY\",\n  \"provider_template_id\": \"<string>\",\n  \"comment\": \"<string>\"\n}")

	req, _ := http.NewRequest("PATCH", url, payload)

	req.Header.Add("Authorization", "<api-key>")
	req.Header.Add("Content-Type", "application/json")

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

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

	fmt.Println(string(body))

}

HttpResponse<String> response = Unirest.patch("https://management-api.suprsend.com/v2/{workspace}/template/{template_slug}/channel/{channel}/variant/{variant_id}/vendor_approval/")
  .header("Authorization", "<api-key>")
  .header("Content-Type", "application/json")
  .body("{\n  \"approval_status\": \"approved\",\n  \"vendor_slug\": \"twilio-whatsapp\",\n  \"vendor_uid\": \"waba_id-123221\",\n  \"vendor_template_name\": \"tpl_v12\",\n  \"vendor_template_id\": \"1232\",\n  \"vendor_locale_code\": \"en\",\n  \"vendor_template_category\": \"UTILITY\",\n  \"provider_template_id\": \"<string>\",\n  \"comment\": \"<string>\"\n}")
  .asString();

require 'uri'
require 'net/http'

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

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

request = Net::HTTP::Patch.new(url)
request["Authorization"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"approval_status\": \"approved\",\n  \"vendor_slug\": \"twilio-whatsapp\",\n  \"vendor_uid\": \"waba_id-123221\",\n  \"vendor_template_name\": \"tpl_v12\",\n  \"vendor_template_id\": \"1232\",\n  \"vendor_locale_code\": \"en\",\n  \"vendor_template_category\": \"UTILITY\",\n  \"provider_template_id\": \"<string>\",\n  \"comment\": \"<string>\"\n}"

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

{
  "$schema": "https://schema.suprsend.com/template/v2/variant_schema.json",
  "channel": "email",
  "id": "default",
  "tenant_id": "<string>",
  "locale": "en",
  "conditions": [
    {}
  ],
  "hash": "<string>",
  "needs_vendor_approval": true,
  "sysgen_template_name": "<string>",
  "approval_status": "auto_approved",
  "discard_comment": "<string>",
  "approval_at": "2023-11-07T05:31:56Z",
  "has_error": true,
  "seq_no": 123,
  "action": "added",
  "created_at": "2023-11-07T05:31:56Z",
  "content": {},
  "vendor_approvals": [
    {}
  ]
}

{
  "code": 400,
  "error_code": "error",
  "type": "ValidationError",
  "message": "[\"cannot update variant approval-status in draft version\"]",
  "detail": [
    "cannot update variant approval-status in draft version"
  ]
}

{
  "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

Query Parameters

Body

Response