For AI agents: visit https://waapi.readme.io/llms.txt for an index of all pages formatted in Markdown and endpoints in OpenAPI. Append .md to any documentation page URL to get its markdown version.
Post an announcement to a Community. Supports text (message), URL-based media (mediaUrl), and broadcast targeting. target='general' (default) posts only to the default announcement subgroup which reaches every community member and returns the message result synchronously. target='all' broadcasts sequentially to every linked subgroup and is ALWAYS dispatched asynchronously — the response contains a reference you can poll via GET /instances/{id}/request/{reference} instead of the message payload. If both message and mediaUrl are provided without mediaCaption, message is used as the media caption. Note: This endpoint is currently in beta and may change without notice.
Recent Requests
Log in to see full request history
Time
Status
User Agent
Retrieving recent requests…
Loading…
Responses
401
Unauthorized — invalid or missing bearer token
403
Forbidden — insufficient permissions or account blocked
404
Not found — instance or community does not exist
409
Conflict — instance is not ready
422
Validation error — invalid or missing request parameters, or the send was refused before it was attempted. A send is refused when the recipient's number is not registered (override with skipNumberCheck: true), or when the connected account is under a reach-out restriction and this exact recipient has already been observed being rejected — contacts who replied are unaffected, and retrying counts towards the limit that caused the restriction. The message field names which of the two applies.
429
Too many requests — rate limit exceeded
Updated 5 months ago
Did this page help you?
Yes
No
Language
ShellNodeRubyPHPPython
Credentials
Bearer
JWT
Bearer
Loading…
Response
Click Try It! to start a request and see the response here! Or choose an example: