Skip to content

Get Messages

Endpoint

http
GET /unified/marketing-automation/messages/{id}
Integrations supported
  • Customer.io

Path parameters

id
string
REQUIRED · 

The ID of the resource.

Example: 23423523

Query parameters

Refer Specifying query parameters in Truto APIs

integrated_account_id
string · uuid
REQUIRED · 

The ID of the integrated account to use for the request.

Example: 62f44730-dd91-461e-bd6a-aedd9e0ad79d
truto_response_format
string

The format of the response.

  • unified will return the response with unified mappings applied.
  • raw will return the raw response from the remote API.
  • normalized will apply the unified mappings and return the data in a normalized format.

Defaults to unified.

All possible enum values:
  • unified
  • raw
  • normalized
Example: unified
truto_ignore_remote_data
boolean

Excludes the remote_data attribute from the response.

truto_exclude_fields
array

Array of fields to exclude from the response.

Example: truto_exclude_fields[]=id&truto_exclude_fields[]=name
remote_query
object

Query parameters to pass to the underlying API without any transformations. Refer this guide to see how to structure the query parameters.

Example: remote_query[foo]=bar

Response Body

id
string
REQUIRED · 

The message's unique identifier

Supported in
  • Customer.io
sender
object

The sender of the message

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

Supported in
  • Customer.io
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

Supported in
  • Customer.io
subject
string

The message's subject line

Supported in
  • Customer.io
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
Supported in
  • Customer.io
campaign
object

The associated campaign for the message

Supported in
  • Customer.io
id
string

Unique identifier of the campaign

template
object

The associated template for the message

Supported in
  • Customer.io
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

Supported in
  • Customer.io
remote_data
object

Raw data returned from the remote API call.