Marcar chat o mensaje como favorito

POST

api

chat

favorite

:instance

Marcar chat o mensaje como favorito

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 o TokenInstance • Rate-limit: Global (100/min) • Idempotente: sí

Descripción

Marca un chat como favorito (pasando number) o un mensaje específico (pasando messageId). Al menos uno de los dos debe estar presente.

Cuando se proporcionan ambos, messageId tiene prioridad, el favorito se registra en el mensaje.

Ejemplos

Marcar chat como favorito

Marca la conversación entera como favorita pasando solo number. Úsalo para destacar contactos importantes en la lista, sin atar el favorito a un mensaje específico.

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)
}

Marcar mensaje como favorito

Marca un mensaje específico como favorito vía messageId. Cuando se envían ambos campos, messageId tiene prioridad y el favorito se registra en el mensaje en lugar del 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)
}

Quitar favorito

Con favorite: false, deshace el favorito previamente registrado en el chat o el mensaje (según el campo proporcionado, misma regla de prioridad que en los ejemplos 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)
}

Respuesta exitosa

El campo type indica qué se marcó: "chat" cuando marcaste la conversación entera, o "message" cuando pasaste un messageId (en ese caso message_id viene relleno). chat_jid siempre se devuelve. favorite refleja el estado final.

200 OK

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

Parámetros de ruta

string

requerido

Nombre de la instancia.

Cabeceras

Nombre	Requerido	Ejemplo	Descripción
`Content-Type`	sí	`application/json`	,
`token`	sí (o `Authorization`)	`a1b2c3d4-...`	TokenAccount o TokenInstance.

Cuerpo de la solicitud

string

Número de teléfono o JID. Úsalo para marcar el chat completo como favorito.

string

ID del mensaje. Úsalo para marcar un mensaje específico como favorito. Tiene prioridad sobre number.

boolean

requerido

true marca como favorito, false quita el favorito.

Debes enviar al menos uno de number y messageId.

Respuestas de error

HTTP	`error.message`	Cuándo ocurre
400	`Instance name is required`	,
400	`Invalid request body: <...>`	JSON malformado.
400	`Either number or messageId is required`	Ninguno proporcionado.
401	`Invalid token`	,
404	`Instance not found`	,
404	`Message not found`	El `messageId` no existe.
503	`Instance is not connected to WhatsApp`	,

Error 400

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

Relacionados

Fijar chat

POST /api/chat/pinChat/:instance

Buscar mensaje

Recupera un mensaje marcado como favorito.

Introducción

Instancia

Eventos

Mensajes

Llamadas

Grupos

Comunidades

Newsletter

Perfil

Chat

Chatwoot

Typebot

Observabilidad

Marcar chat o mensaje como favorito

Descripción

Ejemplos

Marcar chat como favorito

Marcar mensaje como favorito

Quitar favorito

Respuesta exitosa

Parámetros de ruta

Cabeceras

Cuerpo de la solicitud

Respuestas de error

Relacionados

Fijar chat

Buscar mensaje

​Descripción

​Ejemplos

​Marcar chat como favorito

​Marcar mensaje como favorito

​Quitar favorito

​Respuesta exitosa

​Parámetros de ruta

​Cabeceras

​Cuerpo de la solicitud

​Respuestas de error

​Relacionados

Fijar chat

Buscar mensaje

Descripción

Ejemplos

Marcar chat como favorito

Marcar mensaje como favorito

Quitar favorito

Respuesta exitosa

Parámetros de ruta

Cabeceras

Cuerpo de la solicitud

Respuestas de error

Relacionados