Skip to main content
GET
/
api
/
channels
/
whatsapp
/
template
/
{id}
Get WhatsApp Template
curl --request GET \
  --url https://api.hilos.io/api/channels/whatsapp/template/{id} \
  --header 'Authorization: <api-key>'
{
  "name": "<string>",
  "language": "af",
  "components": {},
  "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "category": "ACCOUNT_UPDATE",
  "status": "draft",
  "rejected_reason": "<string>",
  "is_deleted": true,
  "channel": {
    "id": 123,
    "channel_type": "WHATSAPP",
    "name": "<string>",
    "channel_id": "<string>",
    "status": "NEW",
    "created_on": "2023-11-07T05:31:56Z",
    "channel_provider": "META_CLOUD_API",
    "is_sandbox": true
  },
  "is_sample": true
}

Authorizations

Authorization
string
header
required

Token-based authentication with required prefix "Token"

Path Parameters

id
string<uuid>
required

Response

200 - application/json
name
string
required
Maximum length: 120
language
enum<string>
required
Available options:
af,
sq,
ar,
az,
bn,
bg,
ca,
zh_CN,
zh_HK,
zh_TW,
hr,
cs,
da,
nl,
en,
en_GB,
en_US,
et,
fil,
fi,
fr,
ka,
de,
el,
gu,
ha,
he,
hi,
hu,
id,
ga,
it,
ja,
kn,
kk,
rw_RW,
ko,
ky_KG,
lo,
lv,
lt,
mk,
ms,
ml,
mr,
nb,
fa,
pl,
pt_BR,
pt_PT,
pa,
ro,
ru,
sr,
sk,
sl,
es,
es_AR,
es_ES,
es_MX,
sw,
sv,
ta,
te,
th,
tr,
uk,
ur,
uz,
vi,
zu
id
string<uuid>
required

The UUID of the WhatsApp Template to be sent.

category
enum<string>
required
Available options:
ACCOUNT_UPDATE,
PAYMENT_UPDATE,
PERSONAL_FINANCE_UPDATE,
SHIPPING_UPDATE,
RESERVATION_UPDATE,
ISSUE_RESOLUTION,
APPOINTMENT_UPDATE,
TRANSPORTATION_UPDATE,
TICKET_UPDATE,
ALERT_UPDATE,
AUTO_REPLY,
TRANSACTIONAL,
MARKETING,
OTP,
AUTHENTICATION,
UTILITY
channel
object
required

The ID of the WhatsApp Channel that the WhatsApp Template is for.

components
object | null
status
enum<string>
Available options:
draft,
approved,
in_appeal,
pending,
rejected,
pending_deletion,
deleted,
disabled,
submitted
rejected_reason
string | null
is_deleted
boolean
is_sample
boolean