MessageTemplate

object

idrequired: Id
Opaque record id.
channelrequired: TemplateChannel
namerequired: string
display_namerequired: string or null
languagerequired: string
categoryrequired: string
use_caserequired: string or null
headerrequired: any
bodyrequired: string
footerrequired: string or null
buttonsrequired: any
variablesrequired: array of TemplateVariable
provider_template_idrequired: string or null
dlt_template_idrequired: string or null
dlt_headerrequired: string or null
channel_account_idrequired: Id or null
Opaque record id.
statusrequired: TemplateStatus
rejection_reasonrequired: string or null
qualityrequired: string or null
last_synced_atrequired: DateTime or null
Instant in ISO 8601, e.g. 2026-10-03T04:30:00.000Z.
created_atrequired: DateTime
Instant in ISO 8601, e.g. 2026-10-03T04:30:00.000Z.
updated_atrequired: DateTime
Instant in ISO 8601, e.g. 2026-10-03T04:30:00.000Z.
placeholdersrequired: integer
smsrequired: object or null
sms.encodingrequired: "gsm" | "unicode"
sms.partsrequired: integer

Example

{
  "id": "cmusrceel0000q7kaafxqi1om",
  "channel": "sms",
  "name": "string",
  "display_name": "string",
  "language": "string",
  "category": "string",
  "use_case": "string",
  "header": null,
  "body": "string",
  "footer": "string",
  "buttons": null,
  "variables": [
    {
      "index": 1,
      "key": "string",
      "path": "string",
      "label": "string",
      "sample": "string",
      "fallback": "string",
      "max_length": 1
    }
  ],
  "provider_template_id": "string",
  "dlt_template_id": "string",
  "dlt_header": "string",
  "channel_account_id": "cmusrceel0000q7kaafxqi1om",
  "status": "draft",
  "rejection_reason": "string",
  "quality": "string",
  "last_synced_at": "2026-10-06T05:30:00.000Z",
  "created_at": "2026-10-06T05:30:00.000Z",
  "updated_at": "2026-10-06T05:30:00.000Z",
  "placeholders": 0,
  "sms": {
    "encoding": "gsm",
    "parts": 0
  }
}