Skip to content

Authentication

Every request to the omnichannel API must include your API key. Keys are issued per account from the dashboard (Developer → API Key) and must be sent on the apikey HTTP header.

Treat the API key like a password. Do not commit it to source control, put it in a mobile app, or paste it into a public ticket. If it leaks, rotate it in the dashboard before you continue sending.

Headers

  • Name
    apikey
    Type
    string
    Description

    Your dashboard API key. Required on every request.

  • Name
    Content-Type
    Type
    string
    Description

    Use application/json for JSON bodies. Use multipart/form-data only when an endpoint uploads a file, such as WhatsApp header media.

Base URL

The HTTP API host is https://api.azmarq.com. Each endpoint page prints the full URL, such as https://api.azmarq.com/v1/sms. In examples, $API_BASE_URL is https://api.azmarq.com — copy the path from the endpoint bar on the same page.

Example

Authenticated request

curl -X POST "https://api.azmarq.com/v1/sms" \
  -H "Content-Type: application/json" \
  -H "apikey: YOUR_API_KEY" \
  -d '{
    "sender": "senderName",
    "to": "91XXXXXXXXXX",
    "text": "Hello World!",
    "type": "TRANS"
  }'

A missing or unknown key returns:

Error response

{
  "error": true,
  "message": "Api Key not found"
}

The Omni SDK (azmarqomni) and Omni MCP (azmarqomni-mcp) use this same key. The SDK reads AZMARQ_API_KEY and sends apikey. MCP stdio does the same. A public MCP HTTP bind ignores the process env key and requires apikey (or x-api-key) on each request. Some MCP hosts only send Authorization: Bearer …; Azmarq still receives apikey.

See Errors for how to read unsuccessful responses, then Quickstart to send your first message.

Was this page helpful?