Sign in
latestSwagger 2.02026-08-101561322.2 MB

3e4029d19684

Chats

Pin or unpin a chat

<a class="try-sandbox-link" href="https://sandbox.textmagic.com/#/Chats/pinChat" target="_blank">Try in sandbox</a><br>Pin or unpin a single chat.

post/api/v2/chats/pin

Request body

idinteger required

Chat ID.

pinnedinteger required

Pinned value: 0 = unpin, 1 = pin.

Example request

{
  "id": 542,
  "pinned": 1
}

Response

Returned when successful.

idinteger required

Resource ID.

hrefstring required

A link to this resource. If you want to fetch it, just GET this address.

Example response

{
  "id": 515,
  "href": "/api/v2/entity_name/1"
}