Display Identity Records

Request deletion of a DIR

Changed on

Request deletion of a DIR. This does not remove the DIR on this call: it records the request, moves the DIR to delete_requested, and Telnyx completes the removal (de-registration and cleanup) shortly after. A verified DIR keeps serving its branded identity, and keeps billing, until the removal is executed. Failure modes: 400 if a child phone number is still attached or the DIR is in_review (wait for the review to finish), 409 if the DIR has an unresolved infringement claim, 404 if the DIR is not yours.

delete/dir/{dir_id}

Request

  • Base URL: https://api.telnyx.com/v2
  • URL: https://api.telnyx.com/v2/dir/{dir_id}
  • Auth: HTTP bearer

Path parameters

dir_idstring uuid required
Example:16635d38-75a6-4481-82e8-69af60e05011

The DIR id. Lowercase UUID.

Response

Deletion requested. The DIR moves to delete_requested and is torn down shortly after.

Example response

{
  "data": {
    "id": "16635d38-75a6-4481-82e8-69af60e05011",
    "status": "delete_requested"
  }
}

Changes

  • 27a8076ac294Revision changes
    • breaking

      removed the success response with the status

    • info

      added the success response with the status