Sign in
conversations

Set pin order for a conversation

Set pin_order to a number to pin the conversation (0 = first, higher = lower in list). Set pin_order to null to unpin the conversation.

put/admin/v1/conversations/{id}/pin

Request

  • Base URL: / (relative, and the document was published on a file host, not at the API’s origin)
  • URL: /admin/v1/conversations/{id}/pin
  • Auth: HTTP bearer

Path parameters

idstring uuid required

Conversation ID

Request body

pin_orderinteger nullable

The pin order (0 = first, higher = lower in list). Set to null to unpin.

Response

Pin order updated

created_atstring date-time required
idstring uuid required
modelsstring[]

Models used in this conversation

owner_idstring uuid required
owner_type'project' | 'user' required

Owner type for conversations

pin_orderinteger nullable

Pin order for the conversation. NULL = not pinned, 0-N = pinned with order (lower = higher in list)

titlestring required
updated_atstring date-time required

Changes

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