SIsignalshq
CHAT

Bookmark or unbookmark a conversation

Toggle bookmark status for a conversation. Users can bookmark important conversations for future reference or unbookmark previously bookmarked conversations.

post/internal/api/chat/conversations/{conversation_id}/bookmark

Request

  • Base URL
    https://api.signalshq.io (the document declares no server; this is the origin it was published from)
  • Auth
    OAuth 2
    Password
    Token URL: /auth/login

Path parameters

conversation_idstring uuid required

Request body

is_bookmarkedboolean required

Whether to bookmark (True) or unbookmark (False) the conversation

Example request

{
  "is_bookmarked": true
}

Response

Successful Response

statusstring required

Status of the bookmark operation

conversation_idstring uuid required

ID of the bookmarked/unbookmarked conversation

is_bookmarkedboolean required

Current bookmark status of the conversation

Example response

{
  "conversation_id": "123e4567-e89b-12d3-a456-426614174000",
  "is_bookmarked": true,
  "status": "SUCCESS"
}

Changes

No recorded changes to this operation across all 1 revision of this API.