Skip to main content
GET
Get WhatsApp template
Get one WhatsApp template in the authenticated workspace. The response is the template’s renderable definition plus its retry settings. Channel credentials, provider responses, and editor state are never returned.

Required access

Path parameters

string
required
Template UUID. Take id from a List WhatsApp templates response.

Response

object
required
The template definition.
string
Template UUID.
string
WhatsApp channel the template belongs to, when present.
string
Template name as registered with Meta. Names are case-sensitive and are what you pass as template_name when sending.
string
Meta language code, for example en or en_US.
string
Meta category: MARKETING, UTILITY, or AUTHENTICATION.
string
Meta review status, for example APPROVED, PENDING, REJECTED, or DRAFT for templates not yet submitted.
string
TEMPLATE for a standard template or CAROUSEL for a carousel template.
object[]
Meta-style components: HEADER, BODY, FOOTER, BUTTONS, and for carousels CAROUSEL with cards. Placeholders appear as {{1}}, {{2}}, and so on.
object
How Sagepilot fills each placeholder. Keys are header_parameter, body_parameters, button_parameters, and for carousels cards. Each mapping is either {"type": "variable", "variable": "<source.name>"} for a catalog variable or {"type": "value", "value": "..."} for a fixed value.
object
Retry behaviour for campaign and journey sends that use this template.
  • Platform default: null. Failed sends are retried for up to 120 hours.
  • Customized: an object with retry_timeout_hours (1 to 120) and, when retry_window_enabled is true, retry_window_start_hour and retry_window_end_hour (0 to 23, the end may be earlier than the start for an overnight window) plus retry_window_timezone (IANA name such as Asia/Kolkata).
  • Retries off: {"retry_disabled": true}. Failed sends are left failed.

Errors