Appearance

Messages Object ​


id
string
REQUIRED · 

The message's unique identifier

sender
object

The sender of the message

References: Users → id
References: Contacts → id
id
string

Unique identifier of the sender

name
string

Name of the sender

type
string

Type of the sender

All possible enum values:
  • contact
  • user
recipient
object

The recipient of the message

References: Users → id
References: Contacts → id
id
string

Unique identifier of the recipient

name
string

Name of the recipient

type
string

Type of the recipient

All possible enum values:
  • contact
  • user
send_date
string · date-time

The date and time that the message was sent

subject
string

The message's subject line

body
string

The message's body

body_html
string

The message's HTML body

status
string

The sending status of the message

channel
string

The medium through which the message was sent

All possible enum values:
  • email
  • webhook
  • in_app
  • slack
  • push
  • twilio
campaign
object

The associated campaign for the message

References: Campaigns → id
id
string

Unique identifier of the campaign

template
object

The associated template for the message

References: Templates → id
id
string

Unique identifier of the template

updated_at
string · date-time

The date and time of the message's last update

created_at
string · date-time

The date and time of the message's creation

remote_data
object

Raw data returned from the remote API call.