WhatsApp · WhatsApp Templates

Look up a library template

Looks up a library template.

GEThttps://api.pozy.ai/v1/whatsapp/template-library

getWhatsAppLibraryTemplate

Request

Send your API key as Authorization: Bearer pz_live_.... Read-only keys can call it. Keys with the accounts resource group disabled get 403 resource_group_disabled. Authentication

Query parameters

Name	Type	Notes
`accountId`required	string
`name`required	string
`language`	string

Example

curl -X GET "https://api.pozy.ai/v1/whatsapp/template-library?accountId=696e0b682d0a31188e7a2ba9&name=Acme" \
  -H "Authorization: Bearer $POZY_API_KEY"

const res = await fetch("https://api.pozy.ai/v1/whatsapp/template-library?accountId=696e0b682d0a31188e7a2ba9&name=Acme", {
  headers: { Authorization: `Bearer ${process.env.POZY_API_KEY}` },
});
const data = await res.json();
if (!res.ok) throw new Error(data?.error ?? `Request failed with status ${res.status}`);
console.log(data);

import os
import requests

resp = requests.get(
    "https://api.pozy.ai/v1/whatsapp/template-library",
    headers={"Authorization": f"Bearer {os.environ['POZY_API_KEY']}"},
    params={
        "accountId": "696e0b682d0a31188e7a2ba9",
        "name": "Acme",
    },
    timeout=30,
)
resp.raise_for_status()
print(resp.json())

Response

200 on success

templateobject
Can be null.
7 child fields
- namestring
- languagestring
- categorystring
- bodystring
- body_paramsarray of string
- availableLanguagesarray of string
- buttonsarray of object
  2 child fields
  typestring
  textstring

200 response

{
  "template": {
    "name": "Acme",
    "language": "en",
    "category": "string",
    "body": "string",
    "body_params": [
      "string"
    ],
    "availableLanguages": [
      "string"
    ],
    "buttons": [
      {
        "type": "string",
        "text": "Hello from Pozy"
      }
    ]
  }
}

Errors

Errors use one shape: { error, type, code, param?, details? }. The ones you are most likely to see here:

400	invalid_request_error	A parameter or body field is missing or invalid. `param` names it.
401	authentication_error	The API key is missing, revoked or expired.
403	permission_error	The key is scoped to other profiles or has this resource group disabled.
429	rate_limit_error	Too many requests this minute. Wait for `Retry-After` seconds.

Every code is listed in Errors.