Fixar chat

POST

api

chat

pinChat

:instance

Fixar chat

curl --request POST \
  --url https://api.example.com/api/chat/pinChat/:instance \
  --header 'Content-Type: application/json' \
  --data '
{
  "number": "<string>",
  "pin": true
}
'

const options = {
  method: 'POST',
  headers: {'Content-Type': 'application/json'},
  body: JSON.stringify({number: '<string>', pin: true})
};

fetch('https://api.example.com/api/chat/pinChat/:instance', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

import requests

url = "https://api.example.com/api/chat/pinChat/:instance"

payload = {
    "number": "<string>",
    "pin": True
}
headers = {"Content-Type": "application/json"}

response = requests.post(url, json=payload, headers=headers)

print(response.text)

Auth: TokenAccount ou TokenInstance • Rate-limit: Global (100/min) • Idempotente: sim

Descrição

Marca um chat como fixado (pin: true) ou remove a fixação (pin: false).

O WhatsApp limita a 3 chats fixados simultaneamente. Tentar fixar um quarto retorna erro do WhatsMeow propagado para a resposta.

Exemplos

Fixar

Com pin: true, o chat é movido para o topo da lista. Lembre que o WhatsApp permite no máximo 3 chats fixados ao mesmo tempo, tentar um quarto retorna erro.

curl -X POST "https://ryzeapi.cloud/api/chat/pinChat/$Instance_Name" \
  -H "token: $Token_Instance" \
  -H "Content-Type: application/json" \
  -d '{
    "number": "5511999999999",
    "pin":    true
  }'

await fetch(`https://ryzeapi.cloud/api/chat/pinChat/${process.env.Instance_Name}`, {
  method: "POST",
  headers: {
    "token":        process.env.Token_Instance,
    "Content-Type": "application/json"
  },
  body: JSON.stringify({
    number: "5511999999999",
    pin:    true
  })
});

import os, requests

requests.post(
    f"https://ryzeapi.cloud/api/chat/pinChat/{os.environ['Instance_Name']}",
    headers={
        "token":        os.environ["Token_Instance"],
        "Content-Type": "application/json"
    },
    json={
        "number": "5511999999999",
        "pin":    True
    }
)

package main

import (
    "net/http"
    "os"
    "strings"
)

func main() {
    body := strings.NewReader(`{
        "number": "5511999999999",
        "pin":    true
    }`)
    req, _ := http.NewRequest("POST", "https://ryzeapi.cloud/api/chat/pinChat/"+os.Getenv("Instance_Name"), body)
    req.Header.Set("token", os.Getenv("Token_Instance"))
    req.Header.Set("Content-Type", "application/json")
    http.DefaultClient.Do(req)
}

Desfixar

Com pin: false, remove a fixação e o chat volta a ordenar normalmente por atividade. Libera espaço no limite de 3 fixados.

curl -X POST "https://ryzeapi.cloud/api/chat/pinChat/$Instance_Name" \
  -H "token: $Token_Instance" \
  -H "Content-Type: application/json" \
  -d '{
    "number": "5511999999999",
    "pin":    false
  }'

await fetch(`https://ryzeapi.cloud/api/chat/pinChat/${process.env.Instance_Name}`, {
  method: "POST",
  headers: {
    "token":        process.env.Token_Instance,
    "Content-Type": "application/json"
  },
  body: JSON.stringify({
    number: "5511999999999",
    pin:    false
  })
});

import os, requests

requests.post(
    f"https://ryzeapi.cloud/api/chat/pinChat/{os.environ['Instance_Name']}",
    headers={
        "token":        os.environ["Token_Instance"],
        "Content-Type": "application/json"
    },
    json={
        "number": "5511999999999",
        "pin":    False
    }
)

package main

import (
    "net/http"
    "os"
    "strings"
)

func main() {
    body := strings.NewReader(`{
        "number": "5511999999999",
        "pin":    false
    }`)
    req, _ := http.NewRequest("POST", "https://ryzeapi.cloud/api/chat/pinChat/"+os.Getenv("Instance_Name"), body)
    req.Header.Set("token", os.Getenv("Token_Instance"))
    req.Header.Set("Content-Type", "application/json")
    http.DefaultClient.Do(req)
}

Resposta de sucesso

A resposta confirma a operação com chat_jid (JID resolvido a partir do number) e pinned refletindo o estado final. A message muda conforme o valor de pin: "Chat pinned successfully" ou "Chat unpinned successfully".

200 OK

{
  "success": true,
  "message": "Chat pinned successfully",
  "chat_jid": "5511999999999@s.whatsapp.net",
  "pinned": true
}

Parâmetros de rota

string

obrigatório

Nome da instância.

Headers

Nome	Obrigatório	Exemplo	Descrição
`Content-Type`	sim	`application/json`	,
`token`	sim (ou `Authorization`)	`a1b2c3d4-...`	TokenAccount ou TokenInstance.

Request body

string

obrigatório

Telefone, JID privado (...@s.whatsapp.net ou ...@lid), JID de grupo (...@g.us) ou newsletter.

boolean

obrigatório

true fixa, false desfixa.

Respostas de erro

HTTP	`error.message`	Quando ocorre
400	`Instance name is required`	,
400	`Invalid request body: <...>`	JSON malformado.
400	`Number is required`	,
401	`Invalid token`	,
404	`Instance not found`	,
503	`Instance is not connected to WhatsApp`	,

Erro 400

{
  "success": false,
  "error": { "message": "Number is required" }
}

Relacionados

Arquivar chat

POST /api/chat/archive/:instance

Favoritar

POST /api/chat/favorite/:instance

Introdução

Instância

Eventos

Mensagens

Chamadas

Grupos

Comunidades

Newsletter

Perfil

Chat

Chatwoot

Typebot

Observabilidade

Descrição

Exemplos

Fixar

Desfixar

Resposta de sucesso

Parâmetros de rota

Headers

Request body

Respostas de erro

Relacionados

Arquivar chat

Favoritar

​Descrição

​Exemplos

​Fixar

​Desfixar

​Resposta de sucesso

​Parâmetros de rota

​Headers

​Request body

​Respostas de erro

​Relacionados

Arquivar chat

Favoritar

Descrição

Exemplos

Fixar

Desfixar

Resposta de sucesso

Parâmetros de rota

Headers

Request body

Respostas de erro

Relacionados