Favoritar chat ou mensagem

POST

api

chat

favorite

:instance

Favoritar chat ou mensagem

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

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

fetch('https://api.example.com/api/chat/favorite/: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/favorite/:instance"

payload = {
    "number": "<string>",
    "messageId": "<string>",
    "favorite": 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 como favorito um chat (informando number) ou uma mensagem específica (informando messageId). Pelo menos um dos dois deve estar presente.

Quando ambos são informados, messageId tem prioridade, o favorito será registrado na mensagem.

Exemplos

Favoritar chat

Marca a conversa inteira como favorita informando apenas number. Usa-se para destacar contatos importantes na lista, sem amarrar o favorito a uma mensagem específica.

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

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

import os, requests

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

package main

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

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

Favoritar mensagem

Favorita uma mensagem específica via messageId. Quando ambos os campos são enviados, messageId tem prioridade e o favorito é registrado na mensagem em vez do chat.

curl -X POST "https://ryzeapi.cloud/api/chat/favorite/$Instance_Name" \
  -H "token: $Token_Instance" \
  -H "Content-Type: application/json" \
  -d '{
    "messageId": "3EB08FCF27E532F1B0F5",
    "favorite":  true
  }'

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

import os, requests

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

package main

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

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

Remover favorito

Com favorite: false, desfaz o favorito previamente registrado no chat ou na mensagem (a depender de qual campo foi informado, mesmo padrão de prioridade dos exemplos anteriores).

curl -X POST "https://ryzeapi.cloud/api/chat/favorite/$Instance_Name" \
  -H "token: $Token_Instance" \
  -H "Content-Type: application/json" \
  -d '{
    "messageId": "3EB08FCF27E532F1B0F5",
    "favorite":  false
  }'

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

import os, requests

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

package main

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

func main() {
    body := strings.NewReader(`{
        "messageId": "3EB08FCF27E532F1B0F5",
        "favorite":  false
    }`)
    req, _ := http.NewRequest("POST", "https://ryzeapi.cloud/api/chat/favorite/"+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

O campo type indica o que foi marcado: "chat" quando você favoritou a conversa inteira, ou "message" quando passou um messageId (nesse caso message_id aparece preenchido). chat_jid é sempre devolvido. favorite reflete o estado final.

200 OK

{
  "success": true,
  "message": "Message favoritada successfully",
  "chat_jid": "5511999999999@s.whatsapp.net",
  "message_id": "3EB08FCF27E532F1B0F5",
  "favorite": true,
  "type": "message"
}

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

Telefone ou JID. Use para favoritar o chat inteiro.

string

ID da mensagem. Use para favoritar uma mensagem específica. Tem prioridade sobre number.

boolean

obrigatório

true favorita, false remove o favorito.

É obrigatório enviar pelo menos um entre number e messageId.

Respostas de erro

HTTP	`error.message`	Quando ocorre
400	`Instance name is required`	,
400	`Invalid request body: <...>`	JSON malformado.
400	`Either number or messageId is required`	Nenhum dos dois informado.
401	`Invalid token`	,
404	`Instance not found`	,
404	`Message not found`	`messageId` inexistente.
503	`Instance is not connected to WhatsApp`	,

Erro 400

{
  "success": false,
  "error": { "message": "Either number or messageId is required" }
}

Relacionados

Fixar chat

POST /api/chat/pinChat/:instance

Buscar mensagem

Recuperar uma mensagem favoritada.

Introdução

Instância

Eventos

Mensagens

Chamadas

Grupos

Comunidades

Newsletter

Perfil

Chat

Chatwoot

Typebot

Observabilidade

Favoritar chat ou mensagem

Descrição

Exemplos

Favoritar chat

Favoritar mensagem

Remover favorito

Resposta de sucesso

Parâmetros de rota

Headers

Request body

Respostas de erro

Relacionados

Fixar chat

Buscar mensagem

​Descrição

​Exemplos

​Favoritar chat

​Favoritar mensagem

​Remover favorito

​Resposta de sucesso

​Parâmetros de rota

​Headers

​Request body

​Respostas de erro

​Relacionados

Fixar chat

Buscar mensagem

Descrição

Exemplos

Favoritar chat

Favoritar mensagem

Remover favorito

Resposta de sucesso

Parâmetros de rota

Headers

Request body

Respostas de erro

Relacionados