Skip to content
API PlatformDevelopers

Make your first request

Get a key, make a safe test call, then go live.

The API Platform API lets your own code do what your team does in the app: keep contacts in step, send WhatsApp templates, work the inbox and get told when things happen.

1. Get a key

Keys are made in the app, under Developer → API keys, by someone who can manage settings. Start with a test key (ak_test_…): it reads your real data but never changes anything.

Keep the key on your server. Put it in an environment variable called API_KEY, never in a web page or a mobile app.

2. Make a read

curl https://mcp.wa-api.cloud/v1/contacts?limit=5 \
  -H "Authorization: Bearer $API_KEY"

You get a page of contacts back as JSON. Lists look like { "data": [...], "next_cursor": "..." }.

3. Try a change safely

Every change can run as a dry run: add ?dry_run=true and the API runs all its checks and tells you what would happen, without doing it. With a test key, every change is a dry run anyway.

curl -X POST "https://mcp.wa-api.cloud/v1/contacts?dry_run=true" \
  -H "Authorization: Bearer $API_KEY" \
  -H "Content-Type: application/json" \
  -d '{ "phone": "+15555550123", "name": "Jane Doe" }'

4. Go live

Swap in a live key (ak_live_…) when you are ready. Add an Idempotency-Key header to every change so a retry never runs twice.

Every tool has an operation path

Each page in this reference also lists an operation path, POST /v1/ops/{tool}, which takes the same fields as a JSON body. Use the resource paths when you can; the operation paths exist so everything is reachable from day one.