Messages

Mark messages as archived

Changed on

Marks the given messages as archived. Archived messages are hidden from the default message list in the feed but can still be accessed and unarchived later.

post/v1/messages/batch/archived

Request

  • Base URL: https://api.knock.app
  • URL: https://api.knock.app/v1/messages/batch/archived
  • Auth: HTTP bearer

Request body

message_idsstring[] required

The message IDs to update the status of.

Example request

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

Response

OK

__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.

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

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": "2025-01-01T00:04:00Z",
    "channel_id": "123e4567-e89b-12d3-a456-426614174000",
    "clicked_at": null,
    "data": {
      "foo": "bar"
    },
    "engagement_statuses": [
      "seen",
      "archived"
    ],
    "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": null,
    "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

  • 3f095ce88c5dRevision changes
    • info

      added the optional property /// to the response with the status

  • 1e590485c902Revision changes
    • breaking

      the response property /// became nullable for the status

    • info

      added the optional property /// to the response with the status

    • info

      added the optional property /// to the response with the status

    • info

      added the optional property /// to the response with the status