Pin a Message

Pins the specified message at the top of its chat, or unpins it, if supported by the provider.
Pinning the message of another user is allowed, but providers might require an admin role or some permissions in a group chat.
Depending on the provider.

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Path Params
string
required
length ≥ 1

The ID of the Chat where the message is.

string
required
length ≥ 1

The ID of the Message to pin or unpin.

string
required
^acc_(.*)$

ID of the Account (acc_xxx) to call the method on behalf of.

Body Params
boolean
required

Set to true to pin the message in the chat, or false to unpin it.

specifics
object

Object containing provider-specific pin data.

Response

Language
Credentials
Header
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json