Phone numbers

Turn monthly renewal of a number on or off

Costs nothing by itself but decides the number's fate: with renewal on, the monthly cost is charged to the credit balance each month; with it off, the number stops working at expires_at and is given up at the provider. Turning it back on before expiry restores the schedule; after expiry the number is gone and would have to be bought again, if it is even still on offer. The flag is required — omitting it is not read as false, because silently switching renewal off on a number the caller never mentioned looks like a vanished number a month later rather than a bad request. PATCH is accepted on the same path with identical semantics.

put/api/v1/phone-numbers/{did}/auto-renew

Request

Base URL: https://wardenpoint.com (the document declares no server; this is the origin it was published from)
URL: https://wardenpoint.com/api/v1/phone-numbers/{did}/auto-renew
Auth: API key in header X-API-Key

Path parameters

didstring uuid required

Phone number UUID.

Request body

auto_renewboolean required

Required. True keeps charging monthly, false lets the number lapse at expiry.

Response

The number, with the new flag.

Example response

{
  "data": {
    "number": "+48221234567",
    "country_code": "PL",
    "currency": "USD"
  }
}

Changes

No recorded changes to this operation across all 1 revision of this API.