Delete Phone Number

openapi: 3.1.0
info:
  title: Delete Phone Number
  version: 1.0.0

paths:
  /api/phone-numbers/{id}:
    delete:
      summary: Delete a phone number
      description: Permanently deletes a configured phone number.
      tags:
        - Phone Numbers

      security:
        - bearerAuth: []

      parameters:
        - in: path
          name: id
          required: true
          schema:
            type: string
          description: Unique identifier of the phone number.

      responses:
        "200":
          description: Phone number deleted successfully.

        "401":
          description: Unauthorized.

        "404":
          description: Phone number not found.

        "409":
          description: Phone number is currently in use.

        "500":
          description: Internal Server Error.

components:
  securitySchemes:
    bearerAuth:
      type: http
      scheme: bearer
      bearerFormat: JWT

curl --location --request DELETE '{{baseUrl}}/api/phone-numbers/6872d4b5f8d7a91234567890' \
--header 'Authorization: Bearer YOUR_ACCESS_TOKEN'

{
  "success": true,
  "message": "Phone number deleted successfully."
}

{
  "success": false,
  "message": "Unauthorized"
}

{
  "success": false,
  "message": "Phone number not found."
}

{
  "success": false,
  "message": "Cannot delete phone number because it is currently associated with an active campaign or AI Agent."
}

{
  "success": false,
  "message": "Failed to delete phone number."
}