Get template

GET

templates

{templateId}

Get template

curl --request GET \
  --url https://api.zavu.dev/v1/templates/{templateId} \
  --header 'Authorization: Bearer <token>'

const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};

fetch('https://api.zavu.dev/v1/templates/{templateId}', 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://api.zavu.dev/v1/templates/{templateId}",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "GET",
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>"
  ],
]);

$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://api.zavu.dev/v1/templates/{templateId}"

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

	req.Header.Add("Authorization", "Bearer <token>")

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

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

	fmt.Println(string(body))

}

require 'uri'
require 'net/http'

url = URI("https://api.zavu.dev/v1/templates/{templateId}")

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

request = Net::HTTP::Get.new(url)
request["Authorization"] = 'Bearer <token>'

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

{
  "id": "<string>",
  "name": "order_confirmation",
  "language": "en",
  "body": "Hi {{1}}, your order {{2}} has shipped.",
  "category": "UTILITY",
  "smsBody": "<string>",
  "telegramBody": "<string>",
  "instagramBody": "<string>",
  "status": "draft",
  "variables": [
    "<string>"
  ],
  "headerType": "<string>",
  "headerContent": "<string>",
  "footer": "<string>",
  "buttons": [
    {
      "type": "quick_reply",
      "text": "<string>",
      "url": "<string>",
      "example": "<string>",
      "phoneNumber": "<string>",
      "otpType": "COPY_CODE",
      "packageName": "<string>",
      "signatureHash": "<string>"
    }
  ],
  "addSecurityRecommendation": true,
  "codeExpirationMinutes": 45,
  "whatsapp": {
    "templateName": "<string>",
    "namespace": "<string>",
    "status": "<string>"
  },
  "createdAt": "2023-11-07T05:31:56Z",
  "updatedAt": "2023-11-07T05:31:56Z"
}

{
  "code": "invalid_request",
  "message": "Phone number is invalid",
  "details": {}
}

{
  "code": "invalid_request",
  "message": "Phone number is invalid",
  "details": {}
}

Authorizations

Authorization

string

header

required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Path Parameters

templateId

string

required

Response

Template details.

string

required

name

string

required

Template name. For WhatsApp, must match the approved template name in Meta.

Example:

"order_confirmation"

language

string

required

Language code.

Example:

"en"

body

string

required

Default template body with variables: positional ({{1}}, {{2}}) or named ({{customer_name}}, {{contact.first_name}}). Templates created in Zavu are submitted to Meta as positional; templates imported from a WhatsApp Business Account keep their original format (named or positional). Used when no channel-specific body is set.

Example:

"Hi {{1}}, your order {{2}} has shipped."

category

enum<string>

required

The category the template is billed under. For a template linked to WhatsApp this is the category Meta currently assigns, not the one it was submitted with: Meta can recategorize a template at approval or at any point afterwards, and that changes what the message costs.

A recategorization reaches this field through the template.status_changed webhook, which carries data.category, and through POST /v1/templates/sync, which reconciles it against Meta. Read one of those rather than assuming the category you sent is the one in force.

For a template that was never submitted to WhatsApp, this is the category stored locally, defaulting to UTILITY.

Available options:

UTILITY,

MARKETING,

AUTHENTICATION

smsBody

string

Channel-specific body for SMS messages. Falls back to body if not set.

telegramBody

string

Channel-specific body for Telegram messages. Falls back to body if not set.

instagramBody

string

Channel-specific body for Instagram messages. Falls back to body if not set.

status

enum<string>

default:draft

Available options:

draft,

pending,

approved,

rejected

variables

string[]

List of variable names for documentation.

headerType

string

Type of header (text, image, video, document).

headerContent

string

Header content (text or media URL).

footer

string

Footer text for the template.

buttons

object[]

Template buttons.

Show child attributes

addSecurityRecommendation

boolean

Add 'Do not share this code' disclaimer. Only for AUTHENTICATION templates.

codeExpirationMinutes

integer

Code expiration time in minutes. Only for AUTHENTICATION templates.

Required range: 1 <= x <= 90

object

WhatsApp-specific template information.

Show child attributes

createdAt

string<date-time>

updatedAt

string<date-time>

⌘I

Get template

curl --request GET \
  --url https://api.zavu.dev/v1/templates/{templateId} \
  --header 'Authorization: Bearer <token>'

const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};

fetch('https://api.zavu.dev/v1/templates/{templateId}', 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://api.zavu.dev/v1/templates/{templateId}",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "GET",
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>"
  ],
]);

$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://api.zavu.dev/v1/templates/{templateId}"

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

	req.Header.Add("Authorization", "Bearer <token>")

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

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

	fmt.Println(string(body))

}

require 'uri'
require 'net/http'

url = URI("https://api.zavu.dev/v1/templates/{templateId}")

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

request = Net::HTTP::Get.new(url)
request["Authorization"] = 'Bearer <token>'

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

{
  "id": "<string>",
  "name": "order_confirmation",
  "language": "en",
  "body": "Hi {{1}}, your order {{2}} has shipped.",
  "category": "UTILITY",
  "smsBody": "<string>",
  "telegramBody": "<string>",
  "instagramBody": "<string>",
  "status": "draft",
  "variables": [
    "<string>"
  ],
  "headerType": "<string>",
  "headerContent": "<string>",
  "footer": "<string>",
  "buttons": [
    {
      "type": "quick_reply",
      "text": "<string>",
      "url": "<string>",
      "example": "<string>",
      "phoneNumber": "<string>",
      "otpType": "COPY_CODE",
      "packageName": "<string>",
      "signatureHash": "<string>"
    }
  ],
  "addSecurityRecommendation": true,
  "codeExpirationMinutes": 45,
  "whatsapp": {
    "templateName": "<string>",
    "namespace": "<string>",
    "status": "<string>"
  },
  "createdAt": "2023-11-07T05:31:56Z",
  "updatedAt": "2023-11-07T05:31:56Z"
}

{
  "code": "invalid_request",
  "message": "Phone number is invalid",
  "details": {}
}

{
  "code": "invalid_request",
  "message": "Phone number is invalid",
  "details": {}
}