Messages

Mark messages as read

Marks the given messages as read. Read more about message engagement statuses here.

post/v1/messages/batch/read

Request body

message_idsstring[] required

The message IDs to update the status of.

Example request

{
  "message_ids": [
    "2w3YUpTTOxuDvZFji8OMsKrG176",
    "2w3YVRbPXMIh8Zq6oBFcVDA5xes"
  ]
}

Response

__typenamestring required

The typename of the schema.

archived_atstring date-time nullable

Timestamp when the message was archived.

channel_idstring uuid required

Deprecated, use channel.id instead.

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

A list of engagement statuses.

idstring required

The unique identifier for the message.

inserted_atstring date-time required

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.

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 required

The timestamp when the resource was last updated.

workflowstring nullable

The key of the workflow that generated the message.

Example response

[
  {
    "__typename": "Message",
    "actors": [
      "user_123"
    ],
    "archived_at": null,
    "channel_id": "123e4567-e89b-12d3-a456-426614174000",
    "clicked_at": null,
    "data": {
      "foo": "bar"
    },
    "engagement_statuses": [
      "seen",
      "read"
    ],
    "id": "1jNaXzB2RZX3LY8wVQnfCKyPnv7",
    "inserted_at": "2021-01-01T00:00:00Z",
    "interacted_at": null,
    "link_clicked_at": null,
    "metadata": {
      "external_id": "123e4567-e89b-12d3-a456-426614174000"
    },
    "read_at": "2025-01-01T00:02:00Z",
    "recipient": "user_123",
    "scheduled_at": null,
    "seen_at": "2025-01-01T00:01:00Z",
    "source": {
      "__typename": "NotificationSource",
      "categories": [
        "collaboration"
      ],
      "key": "comment-created",
      "version_id": "123e4567-e89b-12d3-a456-426614174000"
    },
    "status": "sent",
    "tenant": "tenant_123",
    "updated_at": "2021-01-01T00:00:00Z",
    "workflow": "comment-created"
  }
]

Changes

Changed in 5 of the 30 revisions of this API.15

Dec 8, 2025b4f3f80942152See the full diff
- ○
  added the optional property items/allOf[subschema #1: Message]/source/workflow_recipient_run_id to the response with the 200 status
  response-optional-property-added
- ○
  added the optional property items/allOf[subschema #1: Message]/source/workflow_run_id to the response with the 200 status
  response-optional-property-added
Oct 27, 202540ca41599f572See the full diff
- ○
  added the optional property items/allOf[subschema #1: Message]/channel to the response with the 200 status
  response-optional-property-added
- ○
  response property items/allOf[subschema #1: Message]/channel_id deprecated
  response-property-deprecated
This revision also has 3 changes that name no endpoint, such as unreferenced schemas being removed. See the revision's changelog
Oct 7, 2025fe051300804a1See the full diff
- ○
  added the optional property items/allOf[subschema #1: Message]/source/type to the response with the 200 status
  response-optional-property-added
Aug 27, 2025de67f68640a09See the full diff
- ○
  the response property items/allOf[subschema #1: Message]/__typename became required for the status 200
  response-property-became-required
- ○
  the response property items/allOf[subschema #1: Message]/channel_id became required for the status 200
  response-property-became-required
- ○
  the response property items/allOf[subschema #1: Message]/engagement_statuses became required for the status 200
  response-property-became-required
- ○
  the response property items/allOf[subschema #1: Message]/id became required for the status 200
  response-property-became-required
- ○
  the response property items/allOf[subschema #1: Message]/inserted_at became required for the status 200
  response-property-became-required
- ○
  the response property items/allOf[subschema #1: Message]/recipient became required for the status 200
  response-property-became-required
- ○
  the response property items/allOf[subschema #1: Message]/source became required for the status 200
  response-property-became-required
- ○
  the response property items/allOf[subschema #1: Message]/status became required for the status 200
  response-property-became-required
- ○
  the response property items/allOf[subschema #1: Message]/updated_at became required for the status 200
  response-property-became-required
Jul 10, 2025592610bb4a051See the full diff
- ○
  added the optional property items/allOf[subschema #1: Message]/source/step_ref to the response with the 200 status
  response-optional-property-added

Full history