Cancel number replacement setup

Cancel only an unsubmitted preparation (number_locked), without changing service or contacting the carrier. Supply the current port.id to avoid canceling a newer setup. Submitted, in-progress, completed, and failed transfer records cannot be canceled here. Cleanup remains available when new porting is disabled. Scope: comms_lines_write. Limit: 10 requests every 15 minutes per line.

delete/lines/{e164}/lock

Request

  • Base URL: https://osis.co/api/v1/comms
  • URL: https://osis.co/api/v1/comms/lines/{e164}/lock
  • Auth: HTTP bearer

Path parameters

e164string required

The dedicated line, in E.164 format and URL-encoded (+ becomes %2B, like %2B16285551212).

Request body

port_idstring required

Current preparation ID from POST /lock or GET /port

Example request

{
  "port_id": "lport_0123456789abcdef"
}

Response

Preparation canceled; current number and service unchanged

cancelledtrue

Changes

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