# Pin or unpin a chat

**POST /chat/{chat_jid}/pin**

Pin or unpin a chat conversation to the top of the chat list


## Servers
- http://localhost:3000: http://localhost:3000 ()


## Authentication methods
- Basic auth


## Parameters

### Path parameters
- **chat_jid** (string)
  Chat JID (e.g., phone@s.whatsapp.net for individual or groupid@g.us for group)


### Body: application/json (object)

- **pinned** (boolean)
  Whether to pin (true) or unpin (false) the chat


## Responses
### 200
OK

#### Body: application/json (object)
- **code** (string)

- **message** (string)

- **results** (object)


### 400
Bad Request

#### Body: application/json (object)
- **code** (string)
  HTTP Status Code
- **message** (string)
  Detail error message
- **results** (object)
  additional data

### 401
Unauthorized

#### Body: application/json (object)
- **code** (string)
  HTTP Status Code
- **message** (string)
  Detail error message
- **results** (object)
  additional data

### 404
Chat Not Found

#### Body: application/json (object)
- **code** (string)
  HTTP Status Code
- **message** (string)
  Detail error message
- **results** (object)
  additional data

### 500
Internal Server Error

#### Body: application/json (object)
- **code** (string)
  SYSTEM_CODE_ERROR
- **message** (string)
  Detail error message
- **results** (object)
  additional data


[Powered by Bump.sh](https://bump.sh)