Pin a message

POST

/api/v1/messages/pin

curl --request POST \
  --url http://localhost:3001/api/v1/messages/pin \
  --header 'Authorization: <Authorization>' \
  --header 'Content-Type: application/json' \
  --data '{}'

• Local development
• Production

Pin a one-to-one message so it stays at the top of the chat.

Authorizations

• BearerAuth

Request Body^required

Message pin request

Media typeapplication/json

object

key

additional properties

any

Example^generated

{}

Responses

200

OK

Media typeapplication/json

object

key

additional properties

any

Example^generated

{}

400

Bad Request

Media typeapplication/json

object

error

string

success

boolean

Example^generated

{
  "error": "example",
  "success": true
}

401

Unauthorized

Media typeapplication/json

object

error

string

success

boolean

Example^generated

{
  "error": "example",
  "success": true
}

404

Not Found

Media typeapplication/json

object

error

string

success

boolean

Example^generated

{
  "error": "example",
  "success": true
}

500

Internal Server Error

Media typeapplication/json

object

error

string

success

boolean

Example^generated

{
  "error": "example",
  "success": true
}