Favorite chat or message

POST

api

chat

favorite

:instance

Favorite chat or message

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 or TokenInstance • Rate-limit: Global (100/min) • Idempotent: yes

Description

Marks a chat as favorite (by passing number) or a specific message (by passing messageId). At least one of the two must be present.

When both are provided, messageId takes precedence, the favorite is recorded on the message.

Examples

Favorite a chat

Marks the entire conversation as a favorite by passing only number. Use this to highlight important contacts in the list, without tying the favorite to a specific message.

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

Favorite a message

Favorites a specific message via messageId. When both fields are sent, messageId takes precedence and the favorite is recorded on the message instead of the 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)
}

Remove favorite

With favorite: false, undoes the previously recorded favorite on the chat or the message (depending on which field was provided, same precedence rule as in the previous examples).

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

Success response

The type field indicates what was marked: "chat" when you favorited the entire conversation, or "message" when you passed a messageId (in that case message_id is filled in). chat_jid is always returned. favorite reflects the final state.

200 OK

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

Path parameters

string

required

Instance name.

Headers

Name	Required	Example	Description
`Content-Type`	yes	`application/json`	,
`token`	yes (or `Authorization`)	`a1b2c3d4-...`	TokenAccount or TokenInstance.

Request body

string

Phone number or JID. Use to favorite the entire chat.

string

Message ID. Use to favorite a specific message. Takes precedence over number.

boolean

required

true favorites, false removes the favorite.

You must send at least one of number and messageId.

Error responses

HTTP	`error.message`	When it happens
400	`Instance name is required`	,
400	`Invalid request body: <...>`	Malformed JSON.
400	`Either number or messageId is required`	Neither provided.
401	`Invalid token`	,
404	`Instance not found`	,
404	`Message not found`	`messageId` does not exist.
503	`Instance is not connected to WhatsApp`	,

Error 400

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

Pin chat

POST /api/chat/pinChat/:instance

Find message

Retrieve a favorited message.

Introduction

Instance

Events

Messages

Calls

Groups

Communities

Newsletter

Profile

Chat

Chatwoot

Typebot

Observability

Favorite chat or message

Description

Examples

Favorite a chat

Favorite a message

Remove favorite

Success response

Path parameters

Headers

Request body

Error responses

Pin chat

Find message

​Description

​Examples

​Favorite a chat

​Favorite a message

​Remove favorite

​Success response

​Path parameters

​Headers

​Request body

​Error responses

​Related

Pin chat

Find message

Description

Examples

Favorite a chat

Favorite a message

Remove favorite

Success response

Path parameters

Headers

Request body

Error responses

Related