Pin or unpin a chat
curl --request POST \
--url http://localhost:3000/chat/{chat_jid}/pin \
--header 'Authorization: Basic <encoded-value>' \
--header 'Content-Type: application/json' \
--data '{
"pinned": true
}'import requests
url = "http://localhost:3000/chat/{chat_jid}/pin"
payload = { "pinned": True }
headers = {
"Authorization": "Basic <encoded-value>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {Authorization: 'Basic <encoded-value>', 'Content-Type': 'application/json'},
body: JSON.stringify({pinned: true})
};
fetch('http://localhost:3000/chat/{chat_jid}/pin', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_PORT => "3000",
CURLOPT_URL => "http://localhost:3000/chat/{chat_jid}/pin",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "POST",
CURLOPT_POSTFIELDS => json_encode([
'pinned' => true
]),
CURLOPT_HTTPHEADER => [
"Authorization: Basic <encoded-value>",
"Content-Type: application/json"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"strings"
"net/http"
"io"
)
func main() {
url := "http://localhost:3000/chat/{chat_jid}/pin"
payload := strings.NewReader("{\n \"pinned\": true\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("Authorization", "Basic <encoded-value>")
req.Header.Add("Content-Type", "application/json")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.post("http://localhost:3000/chat/{chat_jid}/pin")
.header("Authorization", "Basic <encoded-value>")
.header("Content-Type", "application/json")
.body("{\n \"pinned\": true\n}")
.asString();require 'uri'
require 'net/http'
url = URI("http://localhost:3000/chat/{chat_jid}/pin")
http = Net::HTTP.new(url.host, url.port)
request = Net::HTTP::Post.new(url)
request["Authorization"] = 'Basic <encoded-value>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"pinned\": true\n}"
response = http.request(request)
puts response.read_body{
"code": "SUCCESS",
"message": "Chat pinned successfully",
"results": {
"status": "success",
"message": "Chat pinned successfully",
"chat_jid": "6289685028129@s.whatsapp.net",
"pinned": true
}
}{
"code": 400,
"message": "field cannot be blank",
"results": null
}{
"code": 401,
"message": "Unauthorized access",
"results": null
}{
"code": 404,
"message": "Chat not found",
"results": null
}{
"code": "INTERNAL_SERVER_ERROR",
"message": "you are not loggin",
"results": null
}chat
Pin or unpin a chat
Pin or unpin a chat conversation to the top of the chat list
POST
/
chat
/
{chat_jid}
/
pin
Pin or unpin a chat
curl --request POST \
--url http://localhost:3000/chat/{chat_jid}/pin \
--header 'Authorization: Basic <encoded-value>' \
--header 'Content-Type: application/json' \
--data '{
"pinned": true
}'import requests
url = "http://localhost:3000/chat/{chat_jid}/pin"
payload = { "pinned": True }
headers = {
"Authorization": "Basic <encoded-value>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {Authorization: 'Basic <encoded-value>', 'Content-Type': 'application/json'},
body: JSON.stringify({pinned: true})
};
fetch('http://localhost:3000/chat/{chat_jid}/pin', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_PORT => "3000",
CURLOPT_URL => "http://localhost:3000/chat/{chat_jid}/pin",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "POST",
CURLOPT_POSTFIELDS => json_encode([
'pinned' => true
]),
CURLOPT_HTTPHEADER => [
"Authorization: Basic <encoded-value>",
"Content-Type: application/json"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"strings"
"net/http"
"io"
)
func main() {
url := "http://localhost:3000/chat/{chat_jid}/pin"
payload := strings.NewReader("{\n \"pinned\": true\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("Authorization", "Basic <encoded-value>")
req.Header.Add("Content-Type", "application/json")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.post("http://localhost:3000/chat/{chat_jid}/pin")
.header("Authorization", "Basic <encoded-value>")
.header("Content-Type", "application/json")
.body("{\n \"pinned\": true\n}")
.asString();require 'uri'
require 'net/http'
url = URI("http://localhost:3000/chat/{chat_jid}/pin")
http = Net::HTTP.new(url.host, url.port)
request = Net::HTTP::Post.new(url)
request["Authorization"] = 'Basic <encoded-value>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"pinned\": true\n}"
response = http.request(request)
puts response.read_body{
"code": "SUCCESS",
"message": "Chat pinned successfully",
"results": {
"status": "success",
"message": "Chat pinned successfully",
"chat_jid": "6289685028129@s.whatsapp.net",
"pinned": true
}
}{
"code": 400,
"message": "field cannot be blank",
"results": null
}{
"code": 401,
"message": "Unauthorized access",
"results": null
}{
"code": 404,
"message": "Chat not found",
"results": null
}{
"code": "INTERNAL_SERVER_ERROR",
"message": "you are not loggin",
"results": null
}Authorizations
Basic authentication header of the form Basic <encoded-value>, where <encoded-value> is the base64-encoded string username:password.
Path Parameters
Chat JID (e.g., phone@s.whatsapp.net for individual or groupid@g.us for group)
Body
application/json
Whether to pin (true) or unpin (false) the chat
Example:
true