Numbers

Add a number and start pairing

POST/v2/numbers

Scope:numbers:write
Idempotency-Key:optional
uses quota

Creates a number slot (your plan’s number limit applies) and returns a QR (raw + PNG data URL), or with pairing.method "code" + phone an 8-character code to type in WhatsApp.

Parameters

Headers

Name	Type	Constraints	Description
`Idempotency-Key`optional	Type`string`	Constraints≤ 191 chars	DescriptionYour unique id for this operation (≤ 191 visible ASCII). A retry with the same key and body returns the first answer with `Idempotent-Replayed: true` — it never runs twice. Kept 24 h.
`X-Request-Id`optional	Type`string`	Constraints—	DescriptionOptional: your own request id, echoed back (otherwise we generate `req_…`). Quote it to support.

Body

Name	Type	Constraints	Description
`name`required	Type`string`	Constraints≤ 100 chars	DescriptionDisplay name inside Mursilat only — customers never see it.
`pairing`optional	Type`object`	Constraints—	DescriptionHow to link the phone. Omit for a QR.
`pairing.method`optional	Type`string`	Constraintsone of: qr · codedefault qr	Description`qr` returns a QR to scan; `code` returns an 8-character code to type in WhatsApp (needs `pairing.phone`).
`pairing.phone`optional	Type`string`	Constraints—	DescriptionRequired for `method: "code"` — the number being linked, international digits.

Request

POST /v2/numbers

curl -X POST "https://mursilat.com/api/v2/numbers" \
  -H "Authorization: Bearer $WASLA_API_KEY" \
  -H "Idempotency-Key: order-1042-confirm" \
  -H "Content-Type: application/json" \
  -d '{
  "name": "فرع المعادي",
  "pairing": {
    "method": "qr"
  }
}'

const res = await fetch('https://mursilat.com/api/v2/numbers', {
  method: 'POST',
  headers: {
    Authorization: `Bearer ${process.env.WASLA_API_KEY}`,
    'Idempotency-Key': 'order-1042-confirm',
    'Content-Type': 'application/json',
  },
  body: JSON.stringify({
    "name": "فرع المعادي",
    "pairing": {
      "method": "qr"
    }
  }),
});
const data = await res.json();
if (!res.ok) throw new Error(`${data.error.code}: ${data.error.message}`);
console.log(data);

import os
import requests

headers = {"Authorization": f"Bearer {os.environ['WASLA_API_KEY']}", "Idempotency-Key": "order-1042-confirm"}
res = requests.post(
    "https://mursilat.com/api/v2/numbers",
    headers=headers,
    json={
        "name": "فرع المعادي",
        "pairing": {
            "method": "qr"
        }
    },
    timeout=30,
)
data = res.json()
if not res.ok:
    raise RuntimeError(f"{data['error']['code']}: {data['error']['message']}")
print(data)

<?php
$ch = curl_init('https://mursilat.com/api/v2/numbers');
curl_setopt_array($ch, [
    CURLOPT_CUSTOMREQUEST => 'POST',
    CURLOPT_RETURNTRANSFER => true,
    CURLOPT_HTTPHEADER => [
        'Authorization: Bearer ' . getenv('WASLA_API_KEY'),
        'Idempotency-Key: order-1042-confirm',
        'Content-Type: application/json',
    ],
    CURLOPT_POSTFIELDS => json_encode([
        'name' => 'فرع المعادي',
        'pairing' => [
            'method' => 'qr'
        ]
    ], JSON_UNESCAPED_UNICODE),
]);
$data = json_decode(curl_exec($ch), true);
$status = curl_getinfo($ch, CURLINFO_HTTP_CODE);
if ($status >= 400) { throw new Exception($data['error']['code'] . ': ' . $data['error']['message']); }
print_r($data);

Request — JSON

{
  "name": "فرع المعادي",
  "pairing": {
    "method": "qr"
  }
}

Response

201Example

201 — application/json

{
  "number": {
    "id": "cm1abcd2345efgh6789ijkl",
    "name": "فرع المعادي",
    "phone": null,
    "status": "PAIRING",
    "health": null,
    "numberStatus": "ACTIVE",
    "warmupStage": "WEEK_2",
    "webhook": {
      "configured": true,
      "version": 2,
      "disabled": false
    },
    "createdAt": "2026-10-01T09:00:00.000Z",
    "updatedAt": "2026-10-13T08:00:00.000Z"
  },
  "pairing": {
    "method": "qr",
    "qr": {
      "raw": "2@AbCdEf…",
      "dataUrl": "data:image/png;base64,iVBORw0KGgo…"
    },
    "pairingCode": null,
    "expiresAt": "2026-10-13T08:00:20.000Z",
    "instructions": "On the phone: WhatsApp → Settings → Linked devices → Link a device, then scan."
  }
}

Response schema

Fields of the example answer. Expand objects and arrays.

responseobject2 fields
- numberobject10 fields
  - idstring "cm1abcd2345efgh6789ijkl"
  - namestring "فرع المعادي"
  - phonenull null
  - statusstring "PAIRING"
  - healthnull null
  - numberStatusstring "ACTIVE"
  - warmupStagestring "WEEK_2"
  - webhookobject3 fields
    configuredboolean true
    versioninteger 2
    disabledboolean false
  - createdAtstring "2026-10-01T09:00:00.000Z"
  - updatedAtstring "2026-10-13T08:00:00.000Z"
- pairingobject5 fields
  - methodstring "qr"
  - qrobject2 fields
    rawstring "2@AbCdEf…"
    dataUrlstring "data:image/png;base64,iVBORw0KGgo…"
  - pairingCodenull null
  - expiresAtstring "2026-10-13T08:00:20.000Z"
  - instructionsstring "On the phone: WhatsApp → Settings → Linked devices → Link a device, then scan."

Errors

Besides the authentication, rate-limit and validation errors every endpoint can return:

403PLAN_NUMBERS_LIMIT_REACHEDYour plan’s number limit is reached.
403KEY_NUMBER_RESTRICTEDNumber-restricted keys cannot do account-wide actions.

Errors →

Number Shield & behaviour

The QR links a device to your number: treat it as a secret.

Try it

Send this request from your browser to the Mursilat API.

documented example

Preview — this copy of the docs isn’t on mursilat.com, so the console shows the documented example instead of calling the API.

Real requests use your real number and plan: they can send WhatsApp messages, spend quota and delete data. (uses quota)

API key

Kept only in this tab’s memory: never saved, never put in the URL, sent only to mursilat.com. Reloading the page forgets it.

Idempotency-Key

Body (JSON)

The same request with curl

curl -X POST 'https://mursilat.com/api/v2/numbers' \
  -H "Authorization: Bearer $WASLA_API_KEY" \
  -H 'Accept: application/json' \
  -H 'Content-Type: application/json' \
  -d '{"name":"فرع المعادي","pairing":{"method":"qr"}}'