Docs

Mark message as interacted

Marks a message as `interacted` with by the user. This can include any user action on the message, with optional metadata about the specific interaction. Cannot include more than 5 key-value pairs, must not contain nested data. Read more about message engagement statuses [here](/send-notifications/message-statuses#engagement-status).

Retention policy applied

Mark message as interacted

Marks a message as interacted with by the user. This can include any user action on the message, with optional metadata about the specific interaction. Cannot include more than 5 key-value pairs, must not contain nested data. Read more about message engagement statuses here.

Endpoint

PUT/v1/messages/{message_id}/interacted

Rate limit

Tier 2

Path parameters

message_id

string

The unique identifier for the message.

Request body

metadata

object(any)

Metadata about the interaction.

Returns

Message

Represents a single message that was generated by a workflow for a given channel.

__typename

string

The typename of the schema.

actors

RecipientReference[]

One or more actors that are associated with this message. Note: this is a list that can contain up to 10 actors if the message is produced from a batch.

archived_at

string(date-time)

Timestamp when the message was archived.

channel

object

A configured channel, which is a way to route messages to a provider.

created_at

string(date-time)

The timestamp of when the channel was created.

string

The unique identifier for the channel.

key

string

Unique identifier for the channel within a project (immutable once created).

name

string

The human-readable name of the channel.

provider

string

The ID of the provider that this channel uses to deliver messages.

type

enum(string)

The type of channel, determining what kind of messages it can send.

emailin_appin_app_feedin_app_guidesmspushchathttp

updated_at

string(date-time)

The timestamp of when the channel was last updated.

channel_id

string(uuid)

Deprecated, use channel.id instead.

clicked_at

string(date-time)

Timestamp when the message was clicked.

data

object(any)

Data associated with the message’s workflow run. Includes the workflow trigger request’s data payload merged with any additional data returned by a fetch function. For messages produced after a batch step, includes the payload data from the most-recent trigger request (the final activity in the batch).

engagement_statuses

enum(string)[]

A list of engagement statuses.

seenreadinteractedlink_clickedarchived

string

The unique identifier for the message.

inserted_at

string(date-time)

Timestamp when the resource was created.

interacted_at

string(date-time)

Timestamp when the message was interacted with.

link_clicked_at

string(date-time)

Timestamp when a link in the message was clicked.

metadata

object(any)

The metadata associated with the message.

read_at

string(date-time)

Timestamp when the message was read.

recipient

2 possible types

A reference to a recipient, either a user identifier (string) or an object reference (ID, collection).

scheduled_at

string(date-time)

Timestamp when the message was scheduled to be sent.

seen_at

string(date-time)

Timestamp when the message was seen.

source

object

The workflow or guide that triggered the message.

__typename

string