Documentation Index
Fetch the complete documentation index at: https://developer.voyado.com/llms.txt
Use this file to discover all available pages before exploring further.
Message
The “Message” export is only applicable if you are using the classic (old) editor.
| Field | Description | Data type | Example value |
|---|
| messageId | Unique ID for the message. | GUID | BA270CBB-EAEA-4237-AA4A-A53100909FA2 |
| messageName | Name of the message. | string | 2020-06 Summer season |
| subject | Subject line of the message. | string | ”Digitalize your memories before summer” |
| status | Sending status of the message. | string | scheduled, inprogress or completed |
| scheduledDateTime | When the message started being processed. | datetime | 2012-04-14 16:10:21+01:00 |
| recipientCount | Total number of recipients for the message (0 for postal). | int | 123 134 |
| channel | Which communication channel the message was sent through. | string | sms, email or postal |
| sendList | Which send-list the message was connected to. (Send lists are unique for each client). | string | Campaign, Newsletter |
| messageSource | Whether the message was sent manually or through an automation. | string | Automation |
| isTransactional | Tells if a message was sent transactionally (if true, it doesn’t take the opt-out into account). | boolean | True |
| controlGroupPercent | Shows the percentage of recipients that comprised the control group of the message sendout. | decimal | 5,0 |
| senderStoreId | Presents the store ID if the message was sent for a specific store. | string | 101 |
| changeType | Whether the row was created, updated or deleted. | string | CREATE/UPDATE/DELETE |
MessageDelivery
| Field | Description | Data type | Example value |
|---|
| deliveryId | Unique delivery ID for each contact | GUID | 4A220CBG-EAEA-4237-A59A-B98101209FA2 |
| messageId | Unique ID for the message | GUID | BA270CBB-EAEA-4237-AA4A-A53100909FA2 |
| contactId | Unique contact ID | GUID | 5307c938-55fc-4fd8-9512-aab500977e67 |
| deliveryDateTime | Delivery date or planned delivery date for postal sendouts. | datetime | 2020-04-14 15:12:33+01:00 |
| changeType | Whether the row was created, updated or deleted. | string | CREATE/UPDATE/DELETE |
MessageDeliveryStatus
| Field | Description | Data type | Example value |
|---|
| deliveryId | Unique delivery ID for each contact | GUID | 4A220CBG-EAEA-4237-A59A-B98101209FA2 |
| deliveryStatus | The current status of the delivery. | string | delivered, waiting, hardbounce, softBounce |
| optOutDateTime | Timestamp for when the customer unsubscribed from email communication. | datetime | 2020-04-15 15:19:33+01:00 |
| changeType | Whether the row was created, updated or deleted. | string | CREATE/UPDATE/DELETE |
MessageOpen
| Field | Description | Data type | Example value |
|---|
| openId | Unique open ID (Several IDs can be connected to one delivery) | GUID | 9B520C7G-YAEA-4237-A59A-B98101209FA2 |
| deliveryId | Unique ID for delivery | GUID | 4A220CBG-EAEA-4237-A59A-B98101209FA2 |
| messageId | Unique ID for the message | GUID | BA270CBB-EAEA-4237-AA4A-A53100909FA2 |
| openDateTime | Timestamp when customer opened the email. | datetime | 2020-04-15 18:19:33+01:00 |
| userAgent | In which platform the contact opened the email. | string | Mozilla/5.0 (Macintosh; Intel Mac OS X 10_11_6) AppleWebKit/602.3.12 (KHTML, like Gecko) Version/10.0.2 Safari/602.3.12 |
| changeType | Whether the row was created, updated or deleted. | string | CREATE/UPDATE/DELETE |
MessageClick
| Field | Description | Data type | Example value |
|---|
| clickId | Unique ID for logged click (Several IDs can be connected to one delivery) | GUID | 7C420CBG-RARA-3437-A59A-B98701209FA2 |
| messageId | Unique ID for the message | GUID | 6A220CBG-EAEA-4237-A59A-B98101209FA2 |
| deliveryId | Unique ID for the delivery | GUID | 4A220CBG-EAEA-4237-A59A-B98101209FA2 |
| clickDateTime | Timestamp on when the customer clicked a link in the email. | datetime | 2020-04-15 18:19:33+01:00 |
| url | The link adress which was clicked. | string | https://integrate.voyado.com |
| changeType | Whether the row was created, updated or deleted. | string | CREATE/UPDATE/DELETE |
MessageControlGroup
| Field | Description | Data type | Example value |
|---|
| messageControlGroupId | Unique control group ID (identity) | int | 12345 |
| messageId | Unique ID for the message | GUID | BA270CBB-EAEA-4237-AA4A-A53100909FA2 |
| contactId | Unique ID for the contact | GUID | 5307c938-55fc-4fd8-9512-aab500977e67 |
| changeType | Whether the row was created, updated or deleted. | string | CREATE/UPDATE/DELETE |
