Skip to content

    Arabic or English · ↑↓ to move · Enter to open · Esc to close

    العربية
    On this page

    Number Shield & stats

    Pause a number

    POST/v2/numbers/{numberId}/pause
    • Scope:numbers:write
    • Idempotency-Key:optional
    • changes settings

    5 min – 7 days. Campaigns and sends to new contacts wait; replies to recent chats still work.

    Parameters

    Path

    NameTypeConstraintsDescription
    numberIdrequiredTypestringConstraints—DescriptionNumber id (GET /v2/numbers).

    Headers

    NameTypeConstraintsDescription
    Idempotency-KeyoptionalTypestringConstraints≤ 191 charsDescriptionYour 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-IdoptionalTypestringConstraints—DescriptionOptional: your own request id, echoed back (otherwise we generate req_…). Quote it to support.

    Body

    NameTypeConstraintsDescription
    minutesrequiredTypeintegerConstraints5–10080DescriptionPause length: 5 minutes – 7 days. Campaigns and sends to new contacts wait; replies to people who wrote in the last 24 h still go out.

    Request

    curl -X POST "https://mursilat.com/api/v2/numbers/cm1abcd2345efgh6789ijkl/pause" \
      -H "Authorization: Bearer $WASLA_API_KEY" \
      -H "Idempotency-Key: order-1042-confirm" \
      -H "Content-Type: application/json" \
      -d '{
      "minutes": 120
    }'
    Request — JSON
    {
      "minutes": 120
    }

    Response

    200Example

    200 — application/json
    {
      "numberId": "cm1abcd2345efgh6789ijkl",
      "paused": true,
      "until": "2026-10-13T10:00:00.000Z",
      "reason": "CUSTOMER_PAUSED"
    }

    Response schema

    Fields of the example answer. Expand objects and arrays.

    • responseobject4 fields
      • numberIdstring "cm1abcd2345efgh6789ijkl"
      • pausedboolean true
      • untilstring "2026-10-13T10:00:00.000Z"
      • reasonstring "CUSTOMER_PAUSED"

    Errors

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

    Errors →

    Number Shield & behaviour

    Like every Number Shield pause, it holds campaigns and sends to new contacts; replies to people who wrote in the last 24 h keep working. You can only lift your own pause (NUMBER_PAUSE_NOT_YOURS).

    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. (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.

    Path parameters

    Send this request for real?

    This changes your account settings.

    POST /v2/numbers/{numberId}/pause