Delete Integration

DELETE /api/integrations/{integration_id}

Delete Integration

cURL

curl --request DELETE \
  --url https://api.example.com/api/integrations/{integration_id} \
  --header 'X-API-Key: <x-api-key>' \
  --header 'X-Organization-Id: <x-organization-id>'

Response

{
  "success": true,
  "message": "Integration deleted successfully",
  "data": {
    "integration_id": "intg_a1b2c3d4e5f6",
    "client_id": "org_abc123",
    "name": "Twilio Production",
    "provider": "twilio",
    "category": "telephony",
    "status": "active",
    "created_at": "2024-01-15T10:30:00Z",
    "updated_at": "2024-01-15T10:30:00Z"
  }
}

Delete an integration and its stored credentials. Note that integrations currently referenced by phone numbers cannot be deleted until those phone numbers are reassigned or removed.

Headers

X-API-Key · string · required

Your API key for authentication.

X-Organization-Id · string · required

The organization ID.

Path Parameters

integration_id · string · required

The unique identifier of the integration (format: intg_[a-f0-9]{12}).

Permissions

• integrations:delete (admin, agent_manager)

Response

success · boolean

Indicates if the request was successful.

message · string

Human-readable success message.

data · object

The deleted integration object.

Show properties

integration_id · string

Unique integration identifier.

client_id · string

The organization/client ID this integration belonged to.

name · string

The name of the integration.

provider · string

The provider type (e.g., twilio).

category · string

The category (e.g., telephony).

status · string

Current status.

created_at · string

ISO 8601 timestamp of creation.

updated_at · string

ISO 8601 timestamp of last update.

Response

{
  "success": true,
  "message": "Integration deleted successfully",
  "data": {
    "integration_id": "intg_a1b2c3d4e5f6",
    "client_id": "org_abc123",
    "name": "Twilio Production",
    "provider": "twilio",
    "category": "telephony",
    "status": "active",
    "created_at": "2024-01-15T10:30:00Z",
    "updated_at": "2024-01-15T10:30:00Z"
  }
}

Error Responses

409 Conflict

Returned when the integration is still referenced by one or more phone numbers. The error message will list the phone numbers that must be removed or reassigned first.

{
  "detail": "Integration is still referenced by phone numbers: ['[phone]']. Remove or reassign them first."
}