Rasel / Docs
EN
GET/api/v2/templates/{id}

Get one template by id

Returns one template by the id from the list. It must belong to the account or be a platform default. The row includes officialSender, isPlatformNumber, headerType, and allowsHeaderMediaOverride.

When to use it. Read status or sender binding after create.

Code example

Correct: Read a template

curl --location 'https://raselsms.com/api/v2/templates/6800tpl123def4567890aaaa' \--header 'X-API-Key: YOUR_API_KEY'

Incorrect: Incorrect: missing template

curl --location 'https://raselsms.com/api/v2/templates/000000000000000000000000' \--header 'X-API-Key: YOUR_API_KEY'

The id must belong to the account or a platform default.

Response example

200 — Read a template

{  "data": {    "id": "6800tpl123def4567890aaaa",    "name": "order_ready_notice",    "category": "whatsapp",    "subType": "utility",    "language": "ar",    "status": "approved",    "headerType": "image",    "headerValue": null,    "headerAssetId": null,    "headerPreviewUrl": null,    "allowsHeaderMediaOverride": true,    "provider": "meta",    "officialSenderId": "platform",    "officialSender": {      "id": "platform",      "scope": "platform",      "isPlatform": true,      "isDefault": true,      "label": null,      "phoneNumber": null,      "displayName": "platform"    },    "isPlatformNumber": true,    "isDefault": false,    "createdAt": "2026-09-01T10:00:00.000Z"  }}

404 — Incorrect: missing template

{  "success": false,  "code": "NOT_FOUND",  "error": "Template not found"}

The id must belong to the account or a platform default.

401 — Invalid API key.

{  "success": false,  "requestId": "msgreq_1739012345678_abc123",  "code": "UNAUTHORIZED",  "error": "Missing or invalid API key"}

HTTP request

GET /api/v2/templates/{id}

Request Headers

HeaderTypeDescription
X-API-KeystringYour Rasel API key. Send it on every documented request except inbound webhooks. *

Path parameters

FieldTypeDescription
idstringResource identifier. *

Response Fields

FieldTypeDescriptionExample
dataobjectPrimary payload for list and snapshot endpoints.
data.idstringResource identifier.
data.namestringDisplay name or lowercase template identifier, depending on the endpoint.
data.categoryenumTemplate category: whatsapp, sms, message, or email.
data.subTypeenumTemplate sub-type such as utility, otp, marketing, or free.
data.statusenumDelivery or record status. On send: sent, queued, or scheduled. On other resources it is the row status filter or value.
data.languagestringMeta template language such as ar or en. Used for official WhatsApp templates.
data.bodystringWhatsApp template body with numbered placeholders. Pair with bodyParameters at create and variablesIndexed at send.
data.bodyParametersjsonExample values submitted to Meta for numbered body placeholders.
data.headerTypeenumHeader kind: text, image, video, or document.
data.headerValuestringText header value when headerType is text.
data.headerAssetIdstringId from the media upload path. Not required when headerMedia, file, or headerMediaUrl is sent.
data.headerPreviewUrlstringPreview URL for stored header media.
data.allowsHeaderMediaOverridebooleanTrue when this official WhatsApp template accepts a per-send header file or URL.
data.footerstringOptional WhatsApp footer. Not used on WhatsApp Web session templates.
data.buttonsjsonWhatsApp buttons configured on the template.
data.urlButtonVariablesjsonValues for URL button suffixes on this template.
data.indexedPlaceholdersstring-listNumbered body placeholders, such as {{1}}.
data.contentstringOn unified send: message content object (text, otpCode, or email subject). On templates: SMS or message body, or email HTML/text.
data.parametersjsonExample or bound values for the template body placeholders.
data.providerstringTemplate provider filter or value: user_session, meta, or internal.
data.providerTemplateIdstringExisting official WhatsApp / Meta template id when binding manually.
data.manualProviderenumProvider recorded when this template was bound manually.
data.officialSenderIdstringOfficial WhatsApp sender id from /api/v2/official-senders. Alias of sender.officialId. Use platform for the default Meta number when listing templates.
data.officialSenderobjectOfficial WhatsApp number this template is bound to.
data.officialSender.idstringResource identifier.
data.officialSender.scopeenumplatform when the template uses the default number, otherwise a specific sender.
data.officialSender.isPlatformbooleanTrue when the template uses the platform default number.
data.officialSender.isDefaultbooleanTrue when this sender or template is the account default.
data.officialSender.labelstringReady-to-show sender label combining name and phone.
data.officialSender.phoneNumberstringVerified display number in E.164.
data.officialSender.displayNamestringName shown for this official sender.
data.isPlatformNumberbooleanTrue when the template is bound to the platform default official number.
data.isDefaultbooleanTrue when this sender or template is the account default.
data.createdAtstringCreation timestamp.

Status Codes

StatusDescription
200Success.
401Missing or invalid API key.
404Resource not found for this API key owner.
429Rate limit exceeded, or the maximum number of verification attempts was reached.

Try it

Parameters

Resource identifier.

Request

GET /api/v2/templates/6800tpl123def4567890aaaa

Response

Send a request to see the response.