Thread Bookmarks

List of valid attributes:

Attribute	Description	Specifics
parent_message_id	ID of the parent message of a chat thread	Cannot be set
user_id	ID of the author of a bookmark	Cannot be set
updated_at	Timestamp of a bookmark	Set automatically on create. On update, send it to mark the thread unread.

Create

Creates a bookmark for a thread or updates it if the requesting user already has one. Marks the thread as read. No request body attributes are required.

HTTP Request

POST /api/v1/messages/:message_id/thread_bookmark

Request body

{
  "data": {
    "type": "thread_bookmark",
    "attributes": {}
  }
}

Example response:

{
  "data": {
    "id": "8d0d9b6b-ae0a-4551-98ae-1d3eaca8d152",
    "type": "thread_bookmark",
    "attributes": {
      "parent_message_id": "085b586e-5p97-49a8-uy20-c4336ol6fc38",
      "user_id": "412cc746-4ace-484a-95f3-f49951ab182f",
      "updated_at": "2025-01-01T00:00:00Z"
    }
  }
}

Update

Marks a thread as unread. Only the updated_at field can be sent. That timestamp is the unread position.

HTTP Request

PUT /api/v1/messages/:message_id/thread_bookmark

Request body

{
  "data": {
    "type": "thread_bookmark",
    "attributes": {
      "updated_at": "2025-01-01T00:00:00Z"
    }
  }
}

Example response:

{
  "data": {
    "id": "8d0d9b6b-ae0a-4551-98ae-1d3eaca8d152",
    "type": "thread_bookmark",
    "attributes": {
      "parent_message_id": "085b586e-5p97-49a8-uy20-c4336ol6fc38",
      "user_id": "412cc746-4ace-484a-95f3-f49951ab182f",
      "updated_at": "2025-01-01T00:00:00Z"
    }
  }
}