DeletePolarClawChannel

Updated at:
Copy as MD

Deletes a PolarClaw Channel.

Operation description

Description

Use the DeletePolarClawChannel operation to delete a specified PolarClaw Channel. You can also uninstall the associated channel plugin. Before you delete the channel, back up all important data and ensure that no critical tasks are running on it.

Try it now

Try this API in OpenAPI Explorer, no manual signing needed. Successful calls auto-generate SDK code matching your parameters. Download it with built-in credential security for local usage.

Test

RAM authorization

No authorization for this operation. If you encounter issues with this operation, contact technical support.

Request syntax

POST  HTTP/1.1

Request parameters

Parameter

Type

Required

Description

Example

ApplicationId

string

Yes

The application ID.

pa-**************

ChannelId

string

Yes

The channel ID.

feishu

UninstallPlugin

boolean

No

Specifies whether to uninstall the channel plugin. Default value: false.

true

PluginId

string

No

The plugin ID. This parameter is required if UninstallPlugin is set to true.

openclaw-lark

Restart

boolean

No

Specifies whether to restart the gateway after the channel is deleted. Default value: true.

true

Response elements

Element

Type

Description

Example

object

The data returned for the request.

RequestId

string

The request ID.

2281C6C9-CBAB-1AFD-8400-670750CF6025_2212

Message

string

The returned message.

successful

Code

integer

The response status code.

200

ApplicationId

string

The application ID.

pa-**************

Ok

boolean

Indicates whether the request was successful.

true

ChannelId

string

The ID of the deleted channel.

feishu

PluginUninstalled

boolean

Indicates whether the channel plugin was uninstalled.

true

PluginId

string

The ID of the uninstalled plugin.

openclaw-lark

Restarted

boolean

Indicates whether the gateway was restarted.

true

Examples

Success response

JSON format

{
  "RequestId": "2281C6C9-CBAB-1AFD-8400-670750CF6025_2212",
  "Message": "successful",
  "Code": 200,
  "ApplicationId": "pa-**************",
  "Ok": true,
  "ChannelId": "feishu",
  "PluginUninstalled": true,
  "PluginId": "openclaw-lark",
  "Restarted": true
}

Error codes

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.