Skip to main content
POST
whatsapp.templates.list-details

Authorizations

Authorization
string
header
required

API key: sk_live_…

Headers

Idempotency-Key
string

Optional. A retry with the same key returns the stored result.

Maximum string length: 255
Pramaan-Max-Price-Micro
string

Optional. The most this request may be priced at, in micro-USD (a whole number above 0). It replaces the capability's own price ceiling for this request, lower or higher. Sources that could cost more are left out; when none is left the answer is 400 with the lowest limit that would work.

Pattern: ^[1-9]\d{0,14}$

Body

application/json
accountId
string

The sending account, from social.accounts.list. Optional when only one is connected.

Required string length: 1 - 256
status
enum<string>

Template approval state.

Available options:
approved,
pending,
rejected,
paused,
disabled
category
enum<string>

What the template is for.

Available options:
marketing,
utility,
authentication
type
enum<string>

Template layout. Some layouts require additional media or catalog support.

Available options:
text,
image,
video,
document,
location,
catalog,
product,
carousel,
limited_offer,
gif
language
string

Language code, such as en_US.

Required string length: 1 - 16
Pattern: ^[a-z]{2,3}(_[A-Za-z]{2,4})?$
limit
number

Page size, up to 100.

Required range: x >= 1
cursor
string

Next page cursor.

Required string length: 1 - 2048

Response

The result

results
object[]
required

The matching items.

nextCursor
string

Pass as cursor to get the next page; absent on the last page.