Delete channel instance¶

Delete a channel instance and its associated credentials. After deletion, the instance can no longer be used to send messages or receive callbacks.

HTTP
DELETE $CLOUDSIGMA_API_BASE/workspaces/{workspace_id}/channels/{provider}/instances/{instance_id}

Before you call this API¶

Configure the regional API endpoint and authentication, and select the target workspace.

First query the channel instance details and confirm the instance to be deleted.

Set the operation-specific values used in the request:

$WORKSPACE_ID: Target workspace ID, passed through the X-Workspace-ID header and also as workspace_id in the path.
$PROVIDER: Channel Provider ID, as provider in the path.
$INSTANCE_ID: The channel instance ID to delete, as instance_id in the path.

Request¶

Input examples

Shell
curl -X DELETE "$CLOUDSIGMA_API_BASE/workspaces/$WORKSPACE_ID/channels/$PROVIDER/instances/$INSTANCE_ID" \
  -H "X-API-Key: $CLOUDSIGMA_API_KEY" \
  -H "X-Workspace-ID: $WORKSPACE_ID"

Parameter reference

Path parameters

Parameters	Type	Is it required	Description
`workspace_id`	string	Yes	Workspace ID.
`provider`	string	Yes	Channel Provider ID.
`instance_id`	string	Yes	Channel instance ID.

Successful response¶

Returns 200 and the deleted instance snapshot on success. This operation deletes the associated credentials and cannot be restored through the instance.

Response example

JSON
{
  "code": 0,
  "data": {
    "id": "inst_01",
    "workspace_id": "ws_01",
    "provider": "wecom",
    "channel_type": "wecom_mail",
    "name": "告警通道",
    "status": "active",
    "credential_ref": "cred_01"
  }
}

Field reference

The response fields are as follows.

Field	Type	Description
`code`	integer	`0` on success.
`data.id`	string	The ID and workspace of the deleted instance.
`data.workspace_id`	string	The ID and workspace of the deleted instance.
`data.provider`	string	Provider, channel type and status before deletion.
`data.channel_type`	string	Provider, channel type and status before deletion.
`data.status`	string	Provider, channel type and status before deletion.
`data.name`	string	A reference to the instance name and deleted credentials.
`data.credential_ref`	string	A reference to the instance name and deleted credentials.

Error response¶

Response example

JSON
{
  "code": 3,
  "message": "channel instance not found"
}

Field reference

Common HTTP errors¶

HTTP status code	error code	Common causes	Recommended actions
`400`	`2`（`INVALID_ARGUMENT`）	Invalid provider or instance ID.	Check path parameters.
`401`	`6`（`UNAUTHENTICATED`）	Lack of valid identity credentials.	Check API Key.
`403`	`5`（`PERMISSION_DENIED`）	The current identity does not have the permission to delete the instance.	Check workspace authorization.
`404`	`3`（`NOT_FOUND`）	The instance does not exist or does not belong to the Provider in the path.	Check the Provider and Instance ID.
`503`	`15`（`UNAVAILABLE`）	Channel instance services or authorization dependencies are temporarily unavailable.	Try again later.

Follow-up operations¶

To continue using this Provider, please Create channel instance.

Last updated on Sep 15, 2026