Message v1.2
Message provides details on email and SMS campaigns which can be sent to lists by a task.
Message provides details on email and SMS campaigns which can be sent to lists by a task.
Retrieve information on your messages:
name
filter.type
to find messages in the sms
or email
channels.used
will give you all messages which have or have not been scheduled by a task.Message is a read-only endpoint. Use either emailMessage or smsMessage if you need POST, PUT or DELETE methods.
Attribute | Type | Filter | Sort | Description |
---|---|---|---|---|
id | int | Yes | Yes | Unique ID of the message. |
customoptin | bool | Yes | No | Whether the message is a custom opt-in message. |
defaultoptin | bool | Yes | No | Whether the message is the default opt-in message. |
editable | bool | Yes | No | Whether the message is editable. |
name | string | Yes | Yes | Name of the message. |
type | enum | Yes | No | Message type: "email" or "sms" |
used | bool | Yes | No | Whether a message has been used in a scheduled task. |
cdate | decimal | No | Yes | Creation timestamp. |
mdate | decimal | No | No | Last 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.
Attribute | Type | Presence | Description |
---|---|---|---|
id | int | Optional | Unique ID of the message. |
customoptin | bool | Optional | Whether the message is a custom opt-in message. |
defaultoptin | bool | Optional | Whether the message is the default opt-in message. |
editable | bool | Optional | Whether the message is editable. |
name | string | Optional | Name of the message. |
type | enum | Optional | Message type: "email" or "sms" |
used | bool | Optional | Whether a message has been used in a scheduled task. |
This method is not supported - see emailMessage or smsMessage.
This method is not supported - see emailMessage or smsMessage.
This method is not supported - see emailMessage or smsMessage.
There are no error codes for this endpoint.
{ "id": 2209, "customoptin": false, "defaultoptin": false, "editable": true, "name": "Example message", "type": "email", "used": false, "cdate": 1234966741, "mdate": 1234966741, }