Documentation | Messages › Mark Message As Interacted

Messages

messages

Methods

Archive Message ->

Message

put/v1/messages/{message_id}/archived

Archive message

Get Message ->

Message

get/v1/messages/{message_id}

Get message

Get Message Content -> { __typename, data, inserted_at, 1 more... }

get/v1/messages/{message_id}/content

Returns the fully rendered contents of a message, where the response depends on the channel the message was sent on.

List Messages -> EntriesCursor<

Message

get/v1/messages

List messages

List Activities -> ItemsCursor<

Activity

get/v1/messages/{message_id}/activities

List activities

List Delivery Logs -> EntriesCursor<

MessageDeliveryLog

get/v1/messages/{message_id}/delivery_logs

List delivery logs

List Events -> EntriesCursor<

MessageEvent

get/v1/messages/{message_id}/events

List events

Mark Message As Interacted ->

Message

put/v1/messages/{message_id}/interacted

Mark message as interacted

Parameters

message_id: string

Response fields

Message

Request example

curl https://api.knock.app/v1/messages/$MESSAGE_ID/interacted \
    -X PUT \
    -H 'Content-Type: application/json' \
    -H "Authorization: Bearer $KNOCK_API_KEY"

200Example

{
  "id": "1jNaXzB2RZX3LY8wVQnfCKyPnv7",
  "__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"
  ],
  "inserted_at": "2021-01-01T00:00:00Z",
  "interacted_at": null,
  "link_clicked_at": null,
  "metadata": {
    "external_id": "bar"
  },
  "read_at": null,
  "recipient": "user_123",
  "scheduled_at": null,
  "seen_at": null,
  "source": {
    "__typename": "NotificationSource",
    "categories": [
      "collaboration"
    ],
    "key": "comment-created",
    "version_id": "123e4567-e89b-12d3-a456-426614174000"
  },
  "status": "queued",
  "tenant": "tenant_123",
  "updated_at": "2021-01-01T00:00:00Z",
  "workflow": "comment-created"
}