MsgVariantOrderStatusViaTemplate

template objectrequired

A synchronized template ID. Flow metadata adds an automatic Flow button alongside explicit header/body components unless a Flow component was supplied. flow_token personalizes the automatic button; an explicit action flow_token overrides it. Standard WhatsApp templates allow up to 10 buttons total, with at most 10 quick replies, two URL buttons, one phone-number button and one copy-code button, subject to category/type restrictions. Quick replies must be grouped together separately from other button types. Quick-reply, URL and phone-number labels allow 25 characters. These template rules also apply inside the 24-hour service window. Send components supply approved button parameters, not new buttons.

idstring<uuid>required

components object[]

Possible values: <= 100

Array [

oneOf

• object
• object

typestringrequired

Possible values: [header, body, button]

parameters object[]

Possible values: <= 100

Array [

anyOf

• WhatsAppTemplateComponentParameter
• WhatsAppTemplateFlowParameter

Text parameters require variable and text. DYNAMIC template media requires a link in the first header parameter (id alone does not satisfy TEMPLATE_HEADER_MEDIA_LINK_REQUIRED); STATIC media uses the catalog sample URL. Special button parameters remain subject to provider/template compatibility.

oneOf

• object
• object
• object

typestringrequired

Possible values: []

action objectrequired

Provider-specific action record. Flow components use the stricter WhatsAppTemplateFlowParameter shape.

flow_tokenstring

Possible values: non-empty and <= 256 characters

flow_action_data object

screenstring

Possible values: non-empty and <= 256 characters

data object

property name*any

textstringrequired

Possible values: non-empty

image object

linkstring

idstring

document object

linkstring

filenamestring

idstring

video object

linkstring

idstring

location object

Coordinates are required. WhatsApp and Telegram use native location/venue presentation; Telegram venue needs name and address. Instagram/Messenger use a text Maps link fallback.

latitudenumberrequired

Possible values: >= -90 and <= 90

longitudenumberrequired

Possible values: >= -180 and <= 180

namestring

addressstring

variablestringrequired

Required for type:text. Positional identifier such as "1", or a named template variable; named templates map this value to parameter_name.

Possible values: non-empty

coupon_codestring

payloadstring

Possible values: non-empty and <= 1024 characters

]

sub_typestringrequired

Possible values: [flow]

indexnumber

]

flow_tokenstring

Possible values: non-empty and <= 256 characters

orderStatus objectrequired

Supported on compatible WhatsApp connections within an active customer window. Status uses fixed text; custom bodyText is not accepted. Provider requirements may exceed DTO validation.

referenceIdstringrequired

statusWhatsAppOrderStatusrequired

Possible values: [pending, processing, partially_shipped, shipped, completed, canceled]

payment object

statusstringrequired

Possible values: [captured]

timestampnumberrequired

Possible values: >= 0

MsgVariantOrderStatusViaTemplate

{
  "template": {
    "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
    "components": [
      {
        "type": "header",
        "parameters": [
          {
            "type": "text",
            "action": {},
            "text": "string",
            "image": {
              "link": "string",
              "id": "string"
            },
            "document": {
              "link": "string",
              "filename": "string",
              "id": "string"
            },
            "video": {
              "link": "string",
              "id": "string"
            },
            "location": {
              "latitude": 0,
              "longitude": 0,
              "name": "string",
              "address": "string"
            },
            "variable": "string",
            "coupon_code": "string",
            "payload": "string"
          },
          {
            "type": "action",
            "action": {
              "flow_token": "string",
              "flow_action_data": {
                "screen": "string",
                "data": {}
              }
            }
          }
        ],
        "sub_type": "flow",
        "index": 0
      }
    ],
    "flow_token": "string"
  },
  "orderStatus": {
    "referenceId": "string",
    "status": "pending",
    "payment": {
      "status": "captured",
      "timestamp": 0
    }
  }
}