Forward message

POST

api

chat

forward

:instance

Forward message

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

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

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

payload = {
    "messageId": "<string>",
    "to": "<string>"
}
headers = {
    "token": "<token>",
    "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: no Forwards one message to one recipient. For multiple destinations, make multiple calls. Supports forwarding of: text, image, video, audio, document, sticker, contact, location.
Does not support: reactions, polls, buttons.

Examples

To a contact

Forwards the message identified by messageId to an individual contact in to (phone number or @s.whatsapp.net JID). The message arrives at the recipient with the “Forwarded” mark.

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

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

import os, requests

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

package main

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

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

To a group

Same operation, but with to pointing to a group JID (@g.us). Useful to relay notices or media received in another chat to an entire group at once.

curl -X POST "https://ryzeapi.cloud/api/chat/forward/$Instance_Name" \
  -H "token: $Token_Instance" \
  -H "Content-Type: application/json" \
  -d '{
    "messageId": "3EB08FCF27E532F1B0F5",
    "to": "120363406289005073@g.us"
  }'

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

import os, requests

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

package main

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

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

200 OK

{
  "success": true,
  "message": "Message forwarded successfully",
  "messageId": "3EB08FCF27E532F1B0F7",
  "originalId": "3EB08FCF27E532F1B0F5",
  "destinationJid": "5511987654321@s.whatsapp.net"
}

Field	Description
`messageId`	New ID generated by the forward.
`originalId`	ID of the original message.
`destinationJid`	JID of the recipient.

Path parameters

string

required

Instance name.

Headers

string

required

TokenAccount or TokenInstance.

Request body

string

required

ID of the original message (must exist in the instance database).

string

required

Destination: phone number (5511...), private JID (...@s.whatsapp.net or ...@lid), group JID (@g.us), or newsletter (@newsletter).

Notes

Very old media (>14 days) may have its encrypted bytes expired on WhatsApp servers, in that case the forward fails.
The “Forwarded” flag appears naturally for the recipient.
The new message is ingested by the events pipeline and triggers message.exchange (outgoing) on the webhook/WebSocket.

Error responses

HTTP	`error.message`	When
400	`Invalid request body`	Malformed JSON.
400	`messageId is required` or `to is required`	Missing field.
401	`Invalid token`	,
404	`Instance not found` or `message not found`	,
500	`unsupported message type for forwarding: <type>`	Reaction, poll, or interactive.
503	`Instance is not connected to WhatsApp`	No active session.

Introduction

Instance

Events

Messages

Calls

Groups

Communities

Newsletter

Profile

Chat

Chatwoot

Typebot

Observability

Forward message

Examples

To a contact

To a group

Success response

Path parameters

Headers

Request body

Notes

Error responses

​Examples

​To a contact

​To a group

​Success response

​Path parameters

​Headers

​Request body

​Notes

​Error responses

Examples

To a contact

To a group

Success response

Path parameters

Headers

Request body

Notes

Error responses