Skip to main content

Get Template by ID

Retrieve a single WhatsApp message template by its Meta template ID — the numeric id returned by List Templates. Includes the template's body text, parameter format, status, and example values.

Authentication Required

Requires the x-api-key header. See Overview for details.

HTTP Request

GET /api/dragonfly/whatsapp/message_templates/:id

Path Parameters

ParameterTypeRequiredDescription
idstringYesThe Meta template ID (numeric string, e.g. 1249453949471629) — not the template name.

Try it

Loading playground…

Code Examples

curl -X GET "https://prod-api.superfone.co.in/superfone/api/dragonfly/whatsapp/message_templates/1249453949471629" \
-H "x-api-key: your_api_key_here"

Success Response

Status Code: 200 OK

{
"data": {
"name": "hello__",
"parameter_format": "POSITIONAL",
"components": [
{
"type": "BODY",
"text": "Hello sir / ma'am\n {{1}}",
"example": { "body_text": [["Name"]] }
}
],
"language": "en",
"status": "APPROVED",
"category": "MARKETING",
"id": "1249453949471629",
"template_media": null
},
"message": "success"
}

Response Fields

FieldTypeDescription
idstringMeta template ID
namestringTemplate name — the templateName for Send Message
languagestringLanguage code — pass this exact value as language when sending
statusstringApproval status (APPROVED, PENDING, REJECTED, …)
categorystringMARKETING, UTILITY, or AUTHENTICATION
parameter_formatstringPOSITIONAL (variables numbered {{1}}, {{2}}, …) or NAMED (variables like {{name}}, with example.body_text_named_params)
components[]object[]Template structure (HEADER, BODY, FOOTER, BUTTONS) with text and example values
template_mediaobject | nullAttached header media metadata, if any

Error Responses

StatusMessageWhen it occurs
400(Meta error message)Template ID doesn't exist or isn't accessible from your account
401UnAuthorized, Please Provide Valid API KeyMissing or invalid x-api-key