Numbers
Rename a number
PATCH
/v2/numbers/{numberId}- Scope:
numbers:write - Idempotency-Key:optional
- changes settings
Display name in Mursilat only.
Parameters
Path
| Name | Type | Constraints | Description |
|---|---|---|---|
numberIdrequired | Typestring | Constraints— | DescriptionNumber id (GET /v2/numbers). |
Headers
| Name | Type | Constraints | Description |
|---|---|---|---|
Idempotency-Keyoptional | Typestring | 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-Idoptional | Typestring | Constraints— | DescriptionOptional: your own request id, echoed back (otherwise we generate req_…). Quote it to support. |
Body
| Name | Type | Constraints | Description |
|---|---|---|---|
namerequired | Typestring | Constraints≤ 100 chars | DescriptionDisplay name inside Mursilat only — customers never see it. |
Request
curl -X PATCH "https://mursilat.com/api/v2/numbers/cm1abcd2345efgh6789ijkl" \
-H "Authorization: Bearer $WASLA_API_KEY" \
-H "Idempotency-Key: order-1042-confirm" \
-H "Content-Type: application/json" \
-d '{
"name": "فرع مدينة نصر"
}'const res = await fetch('https://mursilat.com/api/v2/numbers/cm1abcd2345efgh6789ijkl', {
method: 'PATCH',
headers: {
Authorization: `Bearer ${process.env.WASLA_API_KEY}`,
'Idempotency-Key': 'order-1042-confirm',
'Content-Type': 'application/json',
},
body: JSON.stringify({
"name": "فرع مدينة نصر"
}),
});
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.patch(
"https://mursilat.com/api/v2/numbers/cm1abcd2345efgh6789ijkl",
headers=headers,
json={
"name": "فرع مدينة نصر"
},
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/cm1abcd2345efgh6789ijkl');
curl_setopt_array($ch, [
CURLOPT_CUSTOMREQUEST => 'PATCH',
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' => 'فرع مدينة نصر'
], 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);{
"name": "فرع مدينة نصر"
}Response
200Example
{
"id": "cm1abcd2345efgh6789ijkl",
"name": "فرع مدينة نصر",
"phone": "201001234567",
"status": "CONNECTED",
"health": {
"level": "good",
"score": 92
},
"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"
}Response schema
Fields of the example answer. Expand objects and arrays.
responseobject10 fields
- idstring "cm1abcd2345efgh6789ijkl"
- namestring "فرع مدينة نصر"
- phonestring "201001234567"
- statusstring "CONNECTED"
healthobject2 fields
- levelstring "good"
- scoreinteger 92
- 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"
Errors
Only the common authentication, rate-limit and validation errors.
Try it
Send this request from your browser to the Mursilat API.
documented examplePreview — 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. (changes settings)
Kept only in this tab’s memory: never saved, never put in the URL, sent only to mursilat.com. Reloading the page forgets it.