Skip to main content

PreparedMessageRead

A prepared message is a reusable templated message for an agent (e.g. an initial outreach line, a ping, or a WABA window opener). The text may contain {variable} placeholders filled in at send time.

idIdrequired

Unique numeric identifier of the record.

product_idProduct Idrequired

ID of the product (workspace) that owns this record. Most endpoints scope access by product.

agent_idAgent Idrequired

ID of the agent (a configured AI assistant / bot persona) this record belongs to.

name objectrequired

Optional human-readable name.

anyOf
string
typeTyperequired

What the prepared message is used for — initial, ping, or waba_opener.

Possible values: [initial, ping, waba_opener]

created_atdate-timerequired

Creation time (UTC, ISO 8601).

messageMessagerequired

The message template text (supports {variable} placeholders).

PreparedMessageRead
{
  "id": 0,
  "product_id": 0,
  "agent_id": 0,
  "name": "string",
  "type": "initial",
  "created_at": "2024-07-29T15:51:28.071Z",
  "message": "string"
}