API Reference Overview

Base URL

https://dev.muchau.com.br/api

Example:

https://dev.muchau.com.br/api/messages/send

Authentication

All endpoints require an API key (except public Signup Link routes):

1
Authorization: Bearer mk_live_<43-chars>

See Authentication for details.

Request format

• Content type: application/json
• Dates: ISO 8601 strings (e.g. 2024-01-15T10:00:00.000Z)
• Phone numbers: international format without + (e.g. 5511999990000)

Response format

All responses are JSON. Successful responses return the resource directly (or an array/paginated object).

Error format

1
{
2
  "error": {
3
    "code": "NOT_FOUND",
4
    "message": "Number not found",
5
    "status": 404
6
  }
7
}

Pagination

List endpoints return a paginated response:

1
{
2
  "data": [ ... ],
3
  "pagination": {
4
    "total": 42,
5
    "limit": 20,
6
    "offset": 0
7
  }
8
}

Query parameters:

Rate limits

Rate limit headers are included on every response:

1
X-RateLimit-Limit: 100
2
X-RateLimit-Remaining: 87
3
X-RateLimit-Reset: 1720000060

When exceeded: 429 Too Many Requests with a Retry-After header.

Idempotency

The POST /api/messages/send endpoint accepts an Idempotency-Key header:

1
Idempotency-Key: <unique-string>

Repeated requests with the same key within 24 hours return the original response without re-processing.