TEtelgea
User Plans

Suspend a customer's number

Stops all traffic on one of a customer's numbers, domestic and international — for a phone that has been lost or stolen. To stop only mobile data and leave the line usable, use the data-restriction endpoint.

The call returns once the line is down at the network, so a 200 means the service is genuinely stopped.

Suspending a number that is already suspended returns 409 and changes nothing.

Not every market offers suspension. Where it does not, this returns 400 and the line stays live — the Markets page in the documentation lists which is which.

post/v1/user-plans/{userId}/suspension

Request

  • Base URL
    https://api.telgea.com
  • Auth
    API key in header x-api-key

Path parameters

userIdstring uuid required

UUID of the user whose plan this is.

Example:9c1f2a6e-3b7d-4e0a-8f21-5d6c7b8a9e01

Headers

idempotency-keystring

A value unique to this request, of 1 to 255 printable ASCII characters — a UUID is the usual choice. Retry with the same key within 24 hours and you get the original response back, even if it was a failure, and nothing is done twice. Send a new key whenever you change the request. Keys are private to your API key and organisation.

Example:0b7e4f1c-6a2d-4c9e-8f35-d1a7b2c93e60

Request body

numberIdstring uuid required

UUID of the number to suspend. Obtain it from the user plan details endpoint.

Example request

{
  "numberId": "8238c1b9-c2c0-4455-9b03-4bd787052709"
}

Response

Number suspended. Lists the number the suspension reached.

numbersstring[] required

The phone numbers the request actually reached at the network.

Example response

{
  "numbers": [
    "+4520123456"
  ]
}

Changes

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