Skip to main content
GET
/
v1
/
whatsapp
/
templates
/
{template_id}
Get Template
curl --request GET \
  --url https://karibu.briq.tz/v1/whatsapp/templates/{template_id} \
  --header 'X-API-Key: <api-key>'
{
  "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "name": "<string>",
  "is_deleted": true,
  "created_at": "2023-11-07T05:31:56Z",
  "updated_at": "2023-11-07T05:31:56Z",
  "language": "en_US",
  "params": [
    "<string>"
  ],
  "details": {},
  "quality_score": "GREEN",
  "whatsapp_sender_number_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "approved_at": "2023-11-07T05:31:56Z",
  "last_sent_at": "2023-11-07T05:31:56Z",
  "rejection_reason_code": "<string>",
  "rejection_reason_text": "<string>"
}

Authorizations

​
X-API-Key
string
header
required

Headers

​
X-API-Key
string
required
​
X-App-ID
string | null

Path Parameters

​
template_id
string<uuid>
required

Response

Successful Response

A WhatsApp message template. Additional lifecycle/meta fields are present but omitted here.

​
id
string<uuid>
required
​
name
string
required

Template name. This is the template_name you pass to send-template.

​
status
enum<string>
required

Only APPROVED templates are sendable.

Available options:
DRAFT,
IN_REVIEW,
APPROVED,
PAUSED,
REJECTED,
DISABLED,
IN_APPEAL,
PENDING_DELETION,
DELETED,
LIMIT_EXCEEDED,
ARCHIVED
​
is_deleted
boolean
required
​
created_at
string<date-time>
required
​
updated_at
string<date-time>
required
​
language
string | null
Example:

"en_US"

​
category
enum<string> | null
Available options:
AUTH,
UTILITY,
MARKETING
​
params
string[] | null

Ordered list of placeholder names. These keys map to the variables object when sending.

​
details
Details · object
​
template_type
enum<string> | null
Available options:
standard,
authentication,
flow,
limited_time_offer
​
parameter_format
enum<string> | null
Available options:
NAMED,
POSITIONAL
​
quality_score
string | null
Example:

"GREEN"

​
whatsapp_sender_number_id
string<uuid> | null

The sender that owns the template.

​
approved_at
string<date-time> | null
​
last_sent_at
string<date-time> | null
​
rejection_reason_code
string | null
​
rejection_reason_text
string | null