Delete Property API

Delete a property

delete

/properties/{id}

Delete a property by its identifier. Deletion is permanent — a removed property cannot be restored.

Authorizations

user-api-keystringRequired

API key for programmatic access, sent in the user-api-key header.

Path parameters

idstring · uuidRequiredExample: 716305c4-561a-4561-a187-7f5b8aeb5920

Query parameters

forcebooleanOptional

Delete the property even when it has connected channels. Without it, a property with at least one channel is refused.

Responses

200

The request has succeeded.

application/json

Success response carrying only a meta message (no resource body).

401

Authentication credentials are missing or invalid.

application/json

404

The requested resource does not exist.

application/json

422

The request has missing or invalid arguments; details lists the messages per argument.

application/json

delete/properties/{id}

DELETE /api/v1/properties/{id} HTTP/1.1
Host: app.channex.io
user-api-key: YOUR_API_KEY
Accept: */*

{
  "meta": {
    "message": "Success"
  }
}