DisablePolarClawChannel

Updated at:
Copy as MD

This API disables a specified PolarClaw channel.

Operation description

Description

Call theDisablePolarClawChannel API to disable a PolarClaw channel for a specific application. Before you perform this operation, make sure you have the target channel ID and the application ID.

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 unique ID of the channel.

feishu

Restart

boolean

No

Specifies whether to restart the gateway after the channel is disabled. Defaults to true.

true

Response elements

Element

Type

Description

Example

object

The response schema.

RequestId

string

The request ID.

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

Message

string

The response message.

successful

Code

integer

The response status code.

200

ApplicationId

string

The application ID.

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

Ok

boolean

Indicates whether the operation was successful.

true

ChannelId

string

The ID of the disabled channel.

feishu

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",
  "Restarted": true
}

Error codes

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.