Message and WhatsApp templates

GEThttps://api.norreach.app/v1/templates

The workspace's saved message templates and its WhatsApp templates with their review state — only APPROVED WhatsApp templates can be sent (POST /messages template).

inbox:readOperation id: list_templates

GET/templates

curl -X GET "https://api.norreach.app/v1/templates" \
  -H "Authorization: Bearer $NORREACH_API_KEY"

Message and WhatsApp templates

{
  "object": "list",
  "data": [
    {
      "id": "6f7a8b9c-0d1e-4f2a-9b3c-4d5e6f7a8b9c",
      "object": "template",
      "kind": "whatsapp",
      "name": "follow_up",
      "channel": "whatsapp",
      "language": "sv",
      "category": "MARKETING",
      "status": "APPROVED",
      "subject": null,
      "body": "Hej {{1}}, …",
      "variable_count": 1
    }
  ],
  "has_more": false,
  "next_cursor": null
}

Authorizations

Authorizationstringheaderrequired

Bearer authentication: send Authorization: Bearer <key>, with an API key or an OAuth access token. The key needs the scope inbox:read. API keys and scopes

Query parameters

kindenumquery

One of:messagewhatsapp

Response

200application/json— Message and WhatsApp templates

object"list"required

dataobject[]required

Show child attributes

data[].idstring (uuid)required

An id (UUID).

data[].object"template"required

data[].kindenumrequired

One of:messagewhatsapp

data[].namestringrequired

data[].channelstringrequired

data[].languagestring | nullrequired

data[].categorystring | nullrequired

data[].statusstring | nullrequired

WhatsApp: the network's review state (only APPROVED templates can be sent).

data[].subjectstring | nullrequired

data[].bodystring | nullrequired

data[].variable_countinteger | nullrequired

has_morebooleanrequired

next_cursorstring | nullrequired

Errors

Errors are application/problem+json with a stable code.

Status	Code	Meaning
400	`bad_request`	The request couldn't be read.
400	`unknown_field`	The request has a field this operation doesn't know.
401	`unauthorized`	A valid API key is required.
403	`insufficient_scope`	This API key doesn't have the scope this operation needs.
403	`feature_not_enabled`	The API isn't switched on for this workspace.
429	`rate_limited`	Too many requests. Slow down and try again.
500	`server_error`	Something went wrong on our side.
503	`unavailable`	The API isn't available right now. Try again shortly.

GET/templates

curl -X GET "https://api.norreach.app/v1/templates" \
  -H "Authorization: Bearer $NORREACH_API_KEY"

Message and WhatsApp templates

{
  "object": "list",
  "data": [
    {
      "id": "6f7a8b9c-0d1e-4f2a-9b3c-4d5e6f7a8b9c",
      "object": "template",
      "kind": "whatsapp",
      "name": "follow_up",
      "channel": "whatsapp",
      "language": "sv",
      "category": "MARKETING",
      "status": "APPROVED",
      "subject": null,
      "body": "Hej {{1}}, …",
      "variable_count": 1
    }
  ],
  "has_more": false,
  "next_cursor": null
}