CreatePolarClawChannel

Updated at:
Copy as MD

Creates a channel in PolarClaw.

Operation description

Request

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's unique identifier.

feishu

PluginId

string

Yes

The channel plugin's name.

openclaw-lark

NpmPackage

string

Yes

The name and version of the npm package for the channel plugin.

@larksuite/openclaw-lark@2026.4.7

ChannelConfig

object

No

The channel configuration.

{ "enabled": true, "dmPolicy": "open", "allowFrom": [ "*" ] }

Restart

boolean

No

Indicates whether to restart the gateway after the channel is created. Default: true.

true

Response elements

Element

Type

Description

Example

object

The returned data.

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 channel that was created.

feishu

PluginInstalled

boolean

Indicates whether a new plugin was installed.

true

PluginId

string

The plugin ID.

openclaw-lark

NpmPackage

string

The name of the installed npm package.

@larksuite/openclaw-lark@2026.4.7

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",
  "PluginInstalled": true,
  "PluginId": "openclaw-lark",
  "NpmPackage": "@larksuite/openclaw-lark@2026.4.7",
  "Restarted": true
}

Error codes

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.