Skip to content

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

    العربية
    On this page

    Number Shield & stats

    Set stricter limits

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

    Applied on every send of the number on top of the Number Shield; the stricter value wins.

    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
    maxPerDayoptionalTypeinteger | nullConstraints≥ 1DescriptionYour own cap per local day (all message classes). null removes it. Can only make sending stricter.
    maxPerHouroptionalTypeinteger | nullConstraints≥ 1DescriptionYour own cap per local hour. null removes it.
    minGapSecondsoptionalTypeinteger | nullConstraints1–3600DescriptionMinimum seconds between two sends of the number (1–3600). The longer of yours and the Shield’s wins.

    Request

    curl -X PUT "https://mursilat.com/api/v2/numbers/cm1abcd2345efgh6789ijkl/limits" \
      -H "Authorization: Bearer $WASLA_API_KEY" \
      -H "Idempotency-Key: order-1042-confirm" \
      -H "Content-Type: application/json" \
      -d '{
      "maxPerDay": 150,
      "maxPerHour": 20,
      "minGapSeconds": 30
    }'
    Request — JSON
    {
      "maxPerDay": 150,
      "maxPerHour": 20,
      "minGapSeconds": 30
    }

    Response

    200Example

    200 — application/json
    {
      "numberId": "cm1abcd2345efgh6789ijkl",
      "maxPerDay": 150,
      "maxPerHour": 20,
      "minGapSeconds": 30,
      "updatedAt": "…"
    }

    Response schema

    Fields of the example answer. Expand objects and arrays.

    • responseobject5 fields
      • numberIdstring "cm1abcd2345efgh6789ijkl"
      • maxPerDayinteger 150
      • maxPerHourinteger 20
      • minGapSecondsinteger 30
      • updatedAtstring "…"

    Errors

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

    Errors →

    Number Shield & behaviour

    Your limits are extra counters on every send of the number. They can only make sending stricter — the Number Shield caps always stay.

    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.

    PUT /v2/numbers/{numberId}/limits