Port-Ins

Discard a failed port-in

Gives up on a port-in that ended in REJECTED or FAILED, when you will not submit it again. The number leaves the plan and stays with the losing carrier. Unless the user has another number, the plan reads INACTIVE, so you can create a user plan with a new number or port in a different one.

The port-in stays readable at its own id and keeps its REJECTED or FAILED status. A discard shows as the number leaving the plan it was being ported onto, and the number's port-ins also leave GET /v1/port-ins/number/{numberId}.

Only a port-in that ended in REJECTED or FAILED can be discarded, and not while a newer port-in for the same number is in flight or once one has succeeded. Either is refused with 400 BAD_REQUEST. Discarding a port-in that is already discarded succeeds and changes nothing.

post/v1/port-ins/{portInId}/discard

Request

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

Path parameters

portInIdstring uuid required

UUID of the port-in request.

Example:c3d4e5f6-a7b8-9012-c345-678901234567

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

Response

Port-in discarded. No content returned.

Changes

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