Skip to content

Relationships

Schema relationships
graph LR
    Messages -->|"sender"| Users
    Messages -->|"sender"| Contacts
    Messages -->|"recipient"| Users
    Messages -->|"recipient"| Contacts
    Messages -->|"campaign"| Campaigns
    Messages -->|"template"| Templates

Properties

idstring
required·

The message's unique identifier

bodystring

The message's body

body_htmlstring

The message's HTML body

campaignobject

The associated campaign for the message

References: Campaigns → id
idstring

Unique identifier of the campaign

channelstring

The medium through which the message was sent

Possible values:
emailwebhookin_appslackpushtwilio
created_atstring · date-time

The date and time of the message's creation

recipientobject

The recipient of the message

References: Users → id
References: Contacts → id
idstring

Unique identifier of the recipient

namestring

Name of the recipient

typestring

Type of the recipient

Possible values:
contactuser
remote_dataRecord<string, any>

Raw data returned from the remote API call.

send_datestring · date-time

The date and time that the message was sent

senderobject

The sender of the message

References: Users → id
References: Contacts → id
idstring

Unique identifier of the sender

namestring

Name of the sender

typestring

Type of the sender

Possible values:
contactuser
statusstring

The sending status of the message

subjectstring

The message's subject line

templateobject

The associated template for the message

References: Templates → id
idstring

Unique identifier of the template

updated_atstring · date-time

The date and time of the message's last update