Archive chat

POST

api

chat

Description

Archives (archive: true) or unarchives (archive: false) a chat. The operation is propagated to WhatsApp via app state, it may take seconds to reflect on the other linked devices.

Examples

Archive

Moves the chat to the archived folder (archive: true), removing it from the main list without deleting history. Syncs with the other linked devices via app state.

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

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

import os, requests

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

package main

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

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

Unarchive

Takes the chat out of the archived folder (archive: false) and brings it back to the main list. The operation is propagated to all linked devices.

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

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

import os, requests

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

package main

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

func main() {
    body := strings.NewReader(`{
        "number":  "5511999999999",
        "archive": false
    }`)
    req, _ := http.NewRequest("POST", "https://ryzeapi.cloud/api/chat/archive/"+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 response confirms the operation with chat_jid (JID resolved from number) and archived reflecting the final state. The message changes depending on the value of archive: "Chat archived successfully" or "Chat unarchived successfully".

200 OK

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

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

required

Phone number, private JID (...@s.whatsapp.net or ...@lid), group JID (...@g.us), or newsletter.

boolean

required

true archives, false unarchives.

Error responses

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

Error 400

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

Pin chat

POST /api/chat/pinChat/:instance

Mute chat

POST /api/chat/mute/:instance

Introduction

Instance

Events

Messages

Calls

Groups

Communities

Newsletter

Profile

Chat

Chatwoot

Typebot

Observability

Description

Examples

Archive

Unarchive

Success response

Path parameters

Headers

Request body

Error responses

Pin chat

Mute chat

​Description

​Examples

​Archive

​Unarchive

​Success response

​Path parameters

​Headers

​Request body

​Error responses

​Related

Pin chat

Mute chat

Description

Examples

Archive

Unarchive

Success response

Path parameters

Headers

Request body

Error responses

Related