Template Status

GET

template

status

Template Status

curl --request GET \
  --url https://platform.chatsyncs.com/api/v1/whatsapp/template/status

const options = {method: 'GET'};

fetch('https://platform.chatsyncs.com/api/v1/whatsapp/template/status', 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://platform.chatsyncs.com/api/v1/whatsapp/template/status",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "GET",
]);

$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://platform.chatsyncs.com/api/v1/whatsapp/template/status"

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

	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://platform.chatsyncs.com/api/v1/whatsapp/template/status")

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

request = Net::HTTP::Get.new(url)

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

{
  "status": "1",
  "message": "Template status fetched successfully.",
  "data": {
    "template_id": "1699518467799904",
    "template_name": "appointment_followup",
    "status": "APPROVED",
    "category": "UTILITY",
    "language": "en_US",
    "quality_score": {
      "score": "UNKNOWN",
      "date": 1788801570
    },
    "rejected_reason": "NONE"
  }
}

Asks WhatsApp where a message template is in review. The answer is live — fetched from WhatsApp on every call — so this is the way to find out when a template you made with Create Template is ready to send. It takes both GET and POST.

Example Request

curl --request GET \
  --url 'https://platform.chatsyncs.com/api/v1/whatsapp/template/status?apiToken=API-KEY&phone_number_id=PHONE-NUMBER-ID&template_id=129847192847198'

Or as a POST with a JSON body:

curl --request POST \
  --url 'https://platform.chatsyncs.com/api/v1/whatsapp/template/status' \
  --header 'Authorization: Bearer API-KEY' \
  --header 'Content-Type: application/json' \
  --data '{ "phone_number_id": "PHONE-NUMBER-ID", "template_id": "129847192847198" }'

template_id here is WhatsApp’s long number (about 15 digits): the template_id that Create Template returns and Bot Template Get lists. It is not ChatSyncs’ short id. The short one is answered with Object with ID … does not exist.

The response

{
  "status": "1",
  "message": "Template status fetched successfully.",
  "data": {
    "template_id": "1699518467799904",
    "template_name": "appointment_followup",
    "status": "APPROVED",
    "category": "UTILITY",
    "language": "en_US",
    "quality_score": { "score": "UNKNOWN", "date": 1788801570 },
    "rejected_reason": "NONE"
  }
}

`status`

`status`	Meaning	What to do
`PENDING`	Still with WhatsApp for review. Usually minutes, up to 24 hours (carousels often longer)	Check again later. Do not recreate it
`APPROVED`	Approved	It can be sent
`REJECTED`	WhatsApp refused it. `rejected_reason` says why	It cannot be sent. Create a corrected copy under a new name
`PAUSED`	Paused for low quality after customers blocked or reported it	Not sendable until the pause ends
`DISABLED`	Disabled after repeated low quality	Create a new template
`FLAGGED`	Flagged for low quality. It still sends	Reword it, or WhatsApp will pause it
`IN_APPEAL`	An appeal is with WhatsApp	Check again later
`PENDING_DELETION`, `DELETED`	Deleted, or being deleted	It cannot be sent

`quality_score`

WhatsApp rates a template by how customers react to it. score is GREEN (high), YELLOW (medium), RED (low) or UNKNOWN. A new template is UNKNOWN until enough messages have gone out. A falling rating is the warning before a pause. date is when the rating was set, as a Unix timestamp.

`rejected_reason`

A reason code from WhatsApp, such as INVALID_FORMAT, when the template was rejected. For every template that was not rejected it is the string NONE — not null — so test for "NONE", not for an empty value.

Approved here does not always mean sendable through ChatSyncs. Bot Template Get shows ChatSyncs’ own copy of the status. A template can be APPROVED here and still read Not Mapped there: WhatsApp has approved it, but its variables are not mapped to contact fields in ChatSyncs yet, so Send Template Message cannot send it. Carousels and templates with a media header have the same limit.

Errors

`message`	What to do
`The phone number id field is required., The template id field is required.`	Send both fields
`Unsupported get request. Object with ID '…' does not exist, cannot be loaded due to missing permissions, or does not support this operation.`	WhatsApp has no template with that ID on this number. Use the long `template_id`, and check the template belongs to this `phone_number_id`
`WhatsApp Bot access token not found.`	`phone_number_id` is not one of this account’s numbers
`Unauthenticated.`	The API key is wrong

Frequently asked

How often should I poll?

A template usually settles within minutes, so every 30 to 60 seconds for the first few minutes, then every few minutes. If it is still PENDING after 24 hours, check it in Chatbot Manager → Message Templates.

Does this tell me about the template's variables?

No. It reports review state and quality only. Bot Template Get lists a template’s body, buttons and variable_map.

Why is my template APPROVED here but Not Mapped in ChatSyncs?

The two answer different questions. WhatsApp decides whether the template may be sent at all. ChatSyncs decides whether it knows how to fill the template’s variables. Map them in ChatSyncs, and the template becomes sendable.

Can an assistant check this for me?

Yes. The ChatSyncs MCP server has a get_template_status ability. Give it a template’s name and it finds the right ID itself.

Query Parameters

apiToken

string

required

Your ChatSyncs API key. Or send it as Authorization: Bearer <key>. Where to find it.

phone_number_id

string

required

The WhatsApp account's phone number ID. Where to find it.

template_id

string

required

WhatsApp's long template ID — the template_id that Create Template returns and Bot Template Get lists (about 15 digits). Not ChatSyncs' short id: that one is answered with Object with ID … does not exist.

Response

Standard ChatSyncs response. status is "1" when WhatsApp answered and "0" on failure.

status

string

"1" = success, "0" = failure.

message

string

Human-readable result, or the failure reason.

data

object

WhatsApp's live view of the template. Present on success.

Show child attributes

Template Status

curl --request GET \
  --url https://platform.chatsyncs.com/api/v1/whatsapp/template/status

const options = {method: 'GET'};

fetch('https://platform.chatsyncs.com/api/v1/whatsapp/template/status', 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://platform.chatsyncs.com/api/v1/whatsapp/template/status",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "GET",
]);

$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://platform.chatsyncs.com/api/v1/whatsapp/template/status"

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

	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://platform.chatsyncs.com/api/v1/whatsapp/template/status")

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

request = Net::HTTP::Get.new(url)

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

{
  "status": "1",
  "message": "Template status fetched successfully.",
  "data": {
    "template_id": "1699518467799904",
    "template_name": "appointment_followup",
    "status": "APPROVED",
    "category": "UTILITY",
    "language": "en_US",
    "quality_score": {
      "score": "UNKNOWN",
      "date": 1788801570
    },
    "rejected_reason": "NONE"
  }
}

Get Started

WhatsApp API

Subscriber API

Label API

Catalog API

User API

Example Request

The response

`status`

`quality_score`

`rejected_reason`

Errors

Frequently asked

Query Parameters

Response

​Example Request

​The response

​status

​quality_score

​rejected_reason

​Errors

​Frequently asked

Query Parameters

Response

Example Request

The response

`status`

`quality_score`

`rejected_reason`

Errors

Frequently asked