Skip to main content
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>"
}
'

Documentation Index

Fetch the complete documentation index at: https://docs.ryzeapi.cloud/llms.txt

Use this file to discover all available pages before exploring further.

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"
  }'

​
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"
  }'

​
Success response

200 OK
{
  "success": true,
  "message": "Message forwarded successfully",
  "messageId": "3EB08FCF27E532F1B0F7",
  "originalId": "3EB08FCF27E532F1B0F5",
  "destinationJid": "5511987654321@s.whatsapp.net"
}
FieldDescription
messageIdNew ID generated by the forward.
originalIdID of the original message.
destinationJidJID of the recipient.

​
Path parameters

​
instance
string
required
Instance name.

​
Headers

​
token
string
required
TokenAccount or TokenInstance.

​
Request body

​
messageId
string
required
ID of the original message (must exist in the instance database).
​
to
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

HTTPerror.messageWhen
400Invalid request bodyMalformed JSON.
400messageId is required or to is requiredMissing field.
401Invalid token—
404Instance not found or message not found—
500unsupported message type for forwarding: <type>Reaction, poll, or interactive.
503Instance is not connected to WhatsAppNo active session.