Documentation

Delete Phone Number

Remove a phone number from a telephony configuration

Remove a phone number from a telephony configuration

Quick reference#

Remove a phone number from a telephony configuration. Send the request to DELETE /api/v1/organizations/telephony-configs/{configid}/phone-numbers/{phonenumberid} on the Paladin API base URL.

Method	`DELETE`
Path	`/api/v1/organizations/telephony-configs/{configid}/phone-numbers/{phonenumberid}`
Path parameters	configid, phonenumberid
Authentication	Use the authentication method shown in the OpenAPI block and the Authentication docs. Keep API keys server-side.

Before you call#

Confirm you are using the production base URL shown in the API reference.
Make sure any path IDs belong to the same Paladin organization as the credential you are using.
Validate request bodies and required fields before sending production traffic.

Common error checks#

Use 401 or 403 responses to check credentials, organization scope, and permissions.
Use 404 responses to check whether the referenced resource exists in the current organization.
Use 422 responses to inspect missing or invalid request fields.

OpenAPI#

DELETE /api/v1/organizations/telephony-configs/{configid}/phone-numbers/{phonenumberid}

openapi: 3.1.0
info:
  title: Paladin API
  description: API for the Paladin app
  version: 1.0.0
servers:
  - url: https://app.paladin.northmanngrp.com
    description: Production

security: []
paths:
  /api/v1/organizations/telephony-configs/{config_id}/phone-numbers/{phone_number_id}:
    delete:
      tags:
        - main
        - organizations
      summary: Delete Phone Number
      operationId: >-
        delete_phone_number_api_v1_organizations_telephony_configs__config_id__phone_numbers__phone_number_id__delete
      parameters:
        - name: config_id
          in: path
          required: true
          schema:
            type: integer
            title: Config Id
        - name: phone_number_id
          in: path
          required: true
          schema:
            type: integer
            title: Phone Number Id
        - name: authorization
          in: header
          required: false
          schema:
            anyOf:
              - type: string
              - type: 'null'
            title: Authorization
        - name: X-API-Key
          in: header
          required: false
          schema:
            anyOf:
              - type: string
              - type: 'null'
            title: X-Api-Key
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema: {}
        '404':
          description: Not found
        '422':
          description: Validation Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HTTPValidationError'
components:
  schemas:
    HTTPValidationError:
      properties:
        detail:
          items:
            $ref: '#/components/schemas/ValidationError'
          type: array
          title: Detail
      type: object
      title: HTTPValidationError
    ValidationError:
      properties:
        loc:
          items:
            anyOf:
              - type: string
              - type: integer
          type: array
          title: Location
        msg:
          type: string
          title: Message
        type:
          type: string
          title: Error Type
        input:
          title: Input
        ctx:
          type: object
          title: Context
      type: object
      required:
        - loc
        - msg
        - type
      title: ValidationError