Scoped keys
whatsapp, instagram, facebook and billing scopes — grant only what is needed.
Create a scoped API key in Settings, send it as a Bearer token, and call JSON endpoints for WhatsApp, Instagram, Facebook and read-only billing.
curl https://api.nexlerai.com/v1/messages \
-H "Authorization: Bearer nx_live_••••" \
-d '{
"to": "+14155550123",
"template": "order_update",
"variables": ["Asha", "#1042"]
}'
201 Created
{ "id": "msg_8f2c", "status": "queued" }Sample data shown for illustration.
Overview
The NexlerAI REST API exposes the same routes the dashboard uses, gated by scope. A key can never reach more than the account that created it already could.
Anyone on any plan can create keys, but API requests only work on Growth and above. Keys are created by an admin under Settings → Security & access → Developer API keys. Pick only the scopes your integration needs. The full key is shown exactly once; the platform stores only a hash and later shows just the prefix and last four characters.
Every response is JSON with a success flag and a data payload; list endpoints add pagination metadata. Errors use standard HTTP status codes so your client can react predictably.
Key management endpoints themselves only accept a signed-in dashboard session, by design — a leaked key can never mint itself a replacement.
Step by step
Settings → Security & access → Developer API keys. Give it a label and scopes.
Copy the key once and keep it out of browsers and mobile apps.
Send Authorization: Bearer <key> to https://nexlerai.com/api/…
Revoke a key and requests using it fail with 401 immediately.
Capabilities
whatsapp, instagram, facebook and billing scopes — grant only what is needed.
Full key returned only at creation; afterwards only prefix and last 4.
Revoked keys fail with 401 on the next request.
success, data and meta envelopes across endpoints.
In the product
Sample data shown for illustration.
Sample data shown for illustration.
Reference
/api/developer/api-keysList keys — prefix and last 4 characters only. Dashboard session required.
/api/developer/api-keysCreate a key with a label and a non-empty scopes array. The response is the only time the full key is returned.
/api/developer/api-keys/:idRevoke a key. Requests using it start failing with 401.
Validation errorThe request body or query is missing something required or is malformed.
UnauthorizedMissing, invalid, revoked or expired API key.
Plan upgrade requiredValid key, but the workspace is on Starter. Developer API access needs Growth or above; the key works as soon as you upgrade.
ForbiddenValid key without the required scope, or the account role does not permit the action.
Not foundThe resource was not found for this workspace.
ConflictFor example, a free-form WhatsApp message outside the 24-hour window.
curl https://nexlerai.com/api/whatsapp/conversations?limit=10 \
-H "Authorization: Bearer nxk_live_your_key_here"
# 200 OK
{
"success": true,
"data": [ { "id": "…", "customer": { "name": "…" }, "conversation": { "status": "open" } } ],
"meta": { "total": 42, "page": 1, "pageSize": 50, "pages": 1 }
}Before you start
Questions
Keys act on the live workspace that created them. Use a separate workspace for testing if you need isolation.
You can create API keys on any plan, but requests made with a key need the Growth plan or above. A key made on Starter starts working as soon as you upgrade.
Nexlerate Technologies Pvt LtdParent company, NexlerAI
Nexlerate Technologies Pvt Ltd is the parent company and engineering team behind NexlerAI. The company builds on the official WhatsApp Cloud API, Meta’s Instagram and Messenger platforms, and the Shopify app ecosystem, and writes these guides from how the product works today.
Connect your workspace first, then upgrade to Growth or Scale when you need more stores, seats and revenue workflows.