The loyalty.message object
Unique identifier for the object.
Time at which the object was created. Measured in seconds since the Unix epoch.
loyalty.message The body of the message shown to the recipient.
The category of the message. null when the message is not categorised.
announcement, event, offer, alert, null The delivery channels used for the message.
1How the message is delivered. push sends a OneMove notification. email sends to the resident or customer email address.
email, push A summary of the OneMove push delivery attempts for the message.
Show child attributes
Show child attributes
A summary of the email delivery attempts for the message. null when email was not one of the requested channels.
Show child attributes
Show child attributes
The reason the message could not be delivered, if it failed.
no_email, no_onemove_user, no_device_tokens, send_error, null The recipient of the message.
- Building
- Option 2
Show child attributes
Show child attributes
The date and time the message was sent.
The status of the message.
failed, pending, sent The title of the message shown to the recipient.
The account that the object belongs to. Only returned if the request is made with a valid Yorlet-Context header.
Only returned if the object has been deleted.
Was this page helpful?
{
"id": "<string>",
"created": 123,
"object": "loyalty.message",
"body": "<string>",
"channels": [],
"delivery": {
"attempted": 123,
"delivered": 123,
"failed": 123,
"skipped": 123,
"read": 0
},
"email_delivery": {
"attempted": 123,
"delivered": 123,
"failed": 123,
"skipped": 123
},
"recipient": {
"type": "building",
"building": "<string>"
},
"sent_at": 123,
"title": "<string>",
"account": "<string>",
"deleted": false
}