Skip to main content

Endpoint

Authentication

x-api-key: <api_key>

Parameters

No path, query, or body parameters.

Request example

Success response 200

How to get the correct instanceId

For all MsgFlash sending endpoints, you must provide instanceId. Field differences: Recommended flow:
  1. Call GET /api/v1/instances.
  2. Choose an instance with status = "connected".
  3. Copy data[n].id.
  4. Use this value as instanceId in:
    • POST /api/v1/messages/send
    • POST /api/v1/messages/schedule
    • POST /api/v1/campaigns

Common errors