Message v1.2

Message provides details on email and SMS campaigns which can be sent to lists by a task.

What can I do with message?

Retrieve information on your messages:

  • Search for messages which match the given name filter.
  • Filter by type to find messages in the sms or email channels.
  • Filtering by used will give you all messages which have or have not been scheduled by a task.
  • When managing users you can choose whether a user has access to all messages. Any users without permission will also have limited access to tasks.

Message is a read-only endpoint. Use either emailMessage or smsMessage if you need POST, PUT or DELETE methods.

GET /message or /message/:id

AttributeTypeFilterSortDescription
id
intYesYesUnique ID of the message.
customoptin
boolYesNoWhether the message is a custom opt-in message.
defaultoptin
boolYesNoWhether the message is the default opt-in message.
editable
boolYesNoWhether the message is editable.
name
stringYesYesName of the message.
type
enumYesNoMessage type: "email" or "sms"
used
boolYesNoWhether a message has been used in a scheduled task.
cdate
decimalNoYesCreation timestamp.
mdate
decimalNoNoLast modification timestamp.

A message will no longer be editable once a scheduled task has been created for the message. Messages are also not editable via the API if they were created using the Campaign Designer or Classic Editor in the Sign-Up.to platform.

HEAD /message or /message/:id

AttributeTypePresenceDescription
id
intOptionalUnique ID of the message.
customoptin
boolOptionalWhether the message is a custom opt-in message.
defaultoptin
boolOptionalWhether the message is the default opt-in message.
editable
boolOptionalWhether the message is editable.
name
stringOptionalName of the message.
type
enumOptionalMessage type: "email" or "sms"
used
boolOptionalWhether a message has been used in a scheduled task.

Error codes

There are no error codes for this endpoint.

Examples

JSON response

{
    "id":               2209,
    "customoptin":      false,
    "defaultoptin":     false,
    "editable":         true,
    "name":             "Example message",
    "type":             "email",
    "used":             false,
    "cdate":            1234966741,
    "mdate":            1234966741,
}