Get a WhatsApp template

GET /templates/{id}

Get a WhatsApp template

cURL

curl --request GET \
  --url https://shortext.ny-corp.io/api/v2.0/templates/{id} \
  --header 'Authorization: Bearer <token>'

200

{
  "success": true,
  "code": 1000,
  "message": "Request success.",
  "body": {
    "id": "<string>",
    "name": "order_update",
    "language": "fr",
    "status": "APPROVED",
    "rejection_reason": "<string>",
    "quality": "GREEN",
    "category": "UTILITY",
    "channels": [
      "<string>"
    ],
    "header": {
      "type": "NONE",
      "text": "<string>",
      "variables": [
        "<string>"
      ],
      "media_url": "<string>"
    },
    "body": {
      "text": "Hello {{name}}, your order {{order}} is ready.",
      "variables": [
        "name",
        "order"
      ]
    },
    "footer": "<string>",
    "buttons": [
      {
        "index": 0,
        "type": "URL",
        "text": "<string>",
        "needs_value": true
      }
    ],
    "updated_at": "2023-11-07T05:31:56Z"
  },
  "token": "<string>",
  "trace_id": "<string>"
}

Authorizations

Authorization · string · header · required

Company API key, sent as Authorization: Bearer <key>. Create it in the dashboard (Developer > API Keys) with the permissions the integration needs.

Path Parameters

id · string · required

Response

200 - application/json

Always HTTP 200: the outcome is in success and code (absolute value of the response code).

success · boolean

Example:

true

code · integer

Example:

1000

message · string

Example:

"Request success."

body · object

Endpoint payload, null when there is none

Show child attributes

token · string | null

Present only on authentication routes

trace_id · string | null

Present only when success is false