Sign in
Messages

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.

put/v1/messages/{message_id}/interacted

Path parameters

message_idstring required

The unique identifier for the message.

Request body

metadataobject

Metadata about the interaction.

Example request

{
  "metadata": {
    "key": "value"
  }
}

Response

OK

__typenamestring

The typename of the schema.

archived_atstring date-time nullable

Timestamp when the message was archived.

channel_idstring uuid

The ID for the channel the message was sent through.

clicked_atstring date-time nullable

Timestamp when the message was clicked.

dataobject nullable

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_statusesstring[]

A list of engagement statuses.

idstring

The unique identifier for the message.

inserted_atstring date-time

Timestamp when the resource was created.

interacted_atstring date-time nullable

Timestamp when the message was interacted with.

link_clicked_atstring date-time nullable

Timestamp when a link in the message was clicked.

metadataobject nullable

The metadata associated with the message.

read_atstring date-time nullable

Timestamp when the message was read.

scheduled_atstring date-time nullable

Timestamp when the message was scheduled to be sent.

seen_atstring date-time nullable

Timestamp when the message was seen.

status'queued' | 'sent' | 'delivered' | 'delivery_attempted' | 'undelivered' | 'not_sent' | 'bounced'

The message delivery status.

tenantstring nullable

The ID of the tenant associated with the message. Only present when a tenant is provided on a workflow trigger request.

updated_atstring date-time

The timestamp when the resource was last updated.

workflowstring nullable

The key of the workflow that generated the message.

Example response

{
  "actors": [
    "mr_arnold",
    "mr_muldoon"
  ],
  "archived_at": null,
  "channel_id": "123e4567-e89b-12d3-a456-426614174000",
  "clicked_at": null,
  "data": {
    "affected_areas": [
      "visitor_center",
      "raptor_pen",
      "trex_paddock"
    ],
    "attraction_id": "paddock_rex_01",
    "evacuation_protocol": "active",
    "message": "Life finds a way",
    "severity": "critical",
    "system_status": "fences_failing"
  },
  "engagement_statuses": [
    "read",
    "seen"
  ],
  "id": "2w3YUpTTOxuDvZFji8OMsKrG176",
  "inserted_at": "1993-06-11T21:15:00Z",
  "interacted_at": null,
  "link_clicked_at": null,
  "metadata": {
    "incident_id": "shutdown-june-1993",
    "initiated_by": "ray_arnold",
    "priority": "critical"
  },
  "read_at": "1993-06-11T21:30:00Z",
  "recipients": "dr_grant",
  "scheduled_at": null,
  "seen_at": "1993-06-11T21:29:45Z",
  "source": {
    "__typename": "Workflow",
    "categories": [
      "security",
      "emergency"
    ],
    "key": "security-breach-alert",
    "step_ref": "alert_step_1",
    "version_id": "123e4567-e89b-12d3-a456-426614174000"
  },
  "status": "sent",
  "tenant": "ingen_isla_nublar",
  "updated_at": "1993-06-11T21:30:05Z",
  "workflow": "security-breach-alert"
}

Changes