Actions137
- Business Actions
- Add Product to Collection
- Add Tag to Chat
- Create Collection
- Create Product
- Create Tag
- Delete Collection
- Delete Product
- Delete Tag
- Edit Collection
- Edit Tag
- Get Available Categories
- Get Business Profile
- Get Product
- Get Products By Phone
- Get Tag Colors
- List Collection Products
- List Collections
- List Products
- List Tags
- Remove Product From Collection
- Remove Tag From Chat
- Save Catalog Config
- Set Business Hours
- Set Categories
- Chat Actions
- Community Actions
- Contact Actions
- Event Actions
- Group Actions
- Instance Actions
- Interactive Message Actions
- Message Actions
- Message Action Actions
- Message Status Actions
- Newsletter Actions
- Poll Actions
- Privacy Actions
- Profile Actions
- Proxy Actions
- Queue Actions
- Status/Story Actions
- Webhook Actions
Message Action → Forward Message
AI-generatedSummary
Forward a message to a recipient phone number via ZeDAPI
Inputs
- phone (required) — Phone number with country code to forward the message to
- messageId (required) — ID of the message to forward
- fromPhone (required) — Source chat phone number or JID where the original message is
- isGroup — Whether the source chat is a group (default false)
- delayMessage — Delay in seconds before forwarding (default 0)
- delayTyping — Typing indicator delay in seconds before forwarding (default 0)
- scheduledFor — ISO 8601 timestamp for scheduled delivery (overrides Delay Message)
- requestOptions — Additional ZeDAPI request configuration such as batching settings or proxy
Output shape
a success response indicating the forwarded message details or an error object
Response contains the forwarded message ID and status; failures return an error envelope with code and message. No pagination.
Examples
Example 1: Forward a text message to a contact instantly
phone: "5511999999999", messageId: "12345", fromPhone: "5511888888888", isGroup: false, delayMessage: 0, delayTyping: 0, scheduledFor: "", requestOptions: {}
Example 2: Schedule a message for delivery the next day
phone: "5511999999999", messageId: "12345", fromPhone: "5511888888888", isGroup: true, delayMessage: 0, delayTyping: 0, scheduledFor: "2025-01-01T12:00:00Z", requestOptions: {}
Example 3: Batch-forward multiple messages using batching options
phone: "5511999999999", messageId: "12345", fromPhone: "5511888888888", isGroup: false, delayMessage: 0, delayTyping: 0, scheduledFor: "", requestOptions: {"batching":{"batchSize":50,"batchInterval":1000}}