Skip to main content
DELETE
/
api
/
v2
/
platform
/
telephony
/
providers-configurations
/
{id}
Delete Provider
curl --request DELETE \
  --url http://localhost:3001/api/v2/platform/telephony/providers-configurations/{id}/ \
  --header 'Authorization: <api-key>' \
  --header 'Org-Handle: <org-handle>'
HTTP/1.1 204 No Content
HTTP/1.1 204 No Content

Delete Provider Configuration

Permanently delete a telephony provider configuration by its ID. Once deleted, this configuration can no longer be used to connect to bridges. This action cannot be undone.
Prerequisites: Make sure you have your API Token and Org-Handle ready. See Authentication for details.
Deleting a provider configuration that is actively connected to a bridge may disrupt call routing. Disconnect the provider from all bridges before deleting.

Path Parameters

NameTypeRequiredDescription
idintegerYesUnique identifier of the provider configuration
You can get the provider configuration id by hitting the Get All Providers API.

Headers

NameTypeRequiredDescription
AuthorizationstringYesAPI Key format: Token <token>
Org-HandlestringYesOrganization domain handle

Common Error Codes

Status CodeDescription
204No Content - Configuration deleted successfully
401Unauthorized - Invalid or missing API token
403Forbidden - Invalid organization handle
404Not Found - Provider configuration not found
500Internal Server Error - Server-side error

Code Examples

const axios = require('axios');

const headers = {
  'Authorization': 'Token your-api-token',
  'Org-Handle': 'your-org-handle'
};

// Delete a provider configuration
const deleteProvider = async (id) => {
  await axios.delete(
    `https://unpod.dev/api/v2/platform/telephony/providers-configurations/${id}/`,
    { headers }
  );
  console.log(`Provider configuration #${id} deleted successfully`);
};

// Example usage
deleteProvider(42);

Best Practices

  1. Disconnect First: Always disconnect the provider from bridges before deleting a configuration
  2. Irreversible: Deletion is permanent — verify the correct id before proceeding
  3. Audit Trail: Note the deletion in your records for compliance and troubleshooting purposes
  4. 204 Response: A successful delete returns HTTP 204 with no body — handle this in your code
  5. Error Handling: Handle 404 gracefully — the configuration may have already been deleted

Authorizations

Authorization
string
header
required

Format: Token

Headers

Org-Handle
string
required

Organization domain handle

Example:

"unpod"

Path Parameters

id
integer
required
Example:

1

Response

Provider deleted