Skip to main content

Remove blocked numbers

POST 
/api/v1/blocked-numbers/remove

Remove numbers from one of your account's two lists of numbers that are skipped when you send to groups:

  • Blocked: numbers that replied STOPP to one of your campaigns, or that were added by hand.
  • Ignored: your own list. It works exactly like the blocked list, except that a number only ends up there when you add it, for example a number that no longer works, so you don't pay to send to it.

Choose the list with type (blocked is the default). Only that list is changed: if the same number is on the other list too, it stays there. Numbers on either list are skipped when you send to groups.

You may only lift a block if the person has asked for it themselves. Sending to someone who has unsubscribed is not allowed.

You can remove 1 to 100 numbers in one request, as a single string or an array of strings. Each number is handled on its own and ends up in either removed or failed, the latter with a reason. A number without a country code, such as 0700000001, is read with the country of your account.

The request succeeds (200, status: success) when at least one number was removed, even if others failed, so check failed on a 200 too. It returns 400 with status: failed only when nothing was removed. Every 400 response still carries removed and failed.

Set testMode to true to try a request without changing anything: nothing is removed, but the response shows what would be removed, and statusText starts with testmode: .

Request​

Body

The number to remove, or an array of up to 100 of them, and optionally which list to remove them from.

    numbers objectrequired

    The number to remove, or an array of 1 to 100 numbers. Use the international format (for example +46700000001); a number without a country code is read with the country of your account.

    oneOf
    string
    typestring

    Which list to remove the numbers from: blocked (the default) or ignored. The other list is not changed.

    Possible values: [blocked, ignored]

    Default value: blocked
    testModeboolean

    Enables test mode for this request, as a dry run: nothing is removed. The response shows which numbers would be removed, and statusText starts with testmode: . Defaults to false.

    Default value: false

Responses​

At least one number was removed. Check failed for any numbers that could not be removed.