DevelopersLive

REST API and scoped API keys: connect your own systems to WhatsApp, Instagram and Facebook.

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.

See pricing
POST /api/whatsapp/messagesDemo
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

What REST API & keys does

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

How it works

  1. 1

    Create a key

    Settings → Security & access → Developer API keys. Give it a label and scopes.

  2. 2

    Store it server-side

    Copy the key once and keep it out of browsers and mobile apps.

  3. 3

    Call the API

    Send Authorization: Bearer <key> to https://nexlerai.com/api/…

  4. 4

    Rotate when needed

    Revoke a key and requests using it fail with 401 immediately.

Capabilities

What you can do

Scoped keys

whatsapp, instagram, facebook and billing scopes — grant only what is needed.

Shown once, stored hashed

Full key returned only at creation; afterwards only prefix and last 4.

Instant revocation

Revoked keys fail with 401 on the next request.

Consistent JSON

success, data and meta envelopes across endpoints.

In the product

See it in action

app.nexlerai.com / inbox
Asha Verma ● online
AI replying
Hi! Is the blue one in stock? I need it by Friday.
Yes, 12 left in your size. Order today and it ships tomorrow.
Blue Runner
$49 · In stock
Type a reply…
Illustration with sample data

Sample data shown for illustration.

app.nexlerai.com / automations / cart-recovery
Trigger
Cart left for 1 hour
Wait
Then check the order is still unpaid
Send WhatsApp
“You left something behind” + 10% code
Live1,204 entered212 recovered · $6.1k
Illustration with sample data

Sample data shown for illustration.

Reference

Key management & errors

GET/api/developer/api-keys

List keys — prefix and last 4 characters only. Dashboard session required.

POST/api/developer/api-keys

Create a key with a label and a non-empty scopes array. The response is the only time the full key is returned.

DELETE/api/developer/api-keys/:id

Revoke a key. Requests using it start failing with 401.

400Validation error

The request body or query is missing something required or is malformed.

401Unauthorized

Missing, invalid, revoked or expired API key.

402Plan upgrade required

Valid key, but the workspace is on Starter. Developer API access needs Growth or above; the key works as soon as you upgrade.

403Forbidden

Valid key without the required scope, or the account role does not permit the action.

404Not found

The resource was not found for this workspace.

409Conflict

For example, a free-form WhatsApp message outside the 24-hour window.

First requestbash
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

Good to know

  • Keep keys server-side — never ship them in browser or mobile code.
  • Customer names, phone numbers and messages are real merchant data; handle them under your own data-protection obligations.
  • Only admins can create or revoke keys.

Questions

Frequently asked

Is there a sandbox?

Keys act on the live workspace that created them. Use a separate workspace for testing if you need isolation.

Which plans include API access?

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.

About the author

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.

Start with the free Starter plan.

Connect your workspace first, then upgrade to Growth or Scale when you need more stores, seats and revenue workflows.