channels.deleteChannel

DELETE

/v1/organization/channels/{channelId}

curl --request DELETE \
  --url https://example.com/v1/organization/channels/example \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '{ "commandKey": "example" }'

Stops Channel work, then deletes the Channel and its links. Read the returned execution to wait for release. Its Chats stay.

Authorizations

• token
• session

Parameters

Path Parameters

channelId

required

string

>= 1 characters <= 128 characters

Request Body^required

Media typeapplication/json

object

commandKey

required

string

>= 1 characters <= 128 characters

Example ^generated

{
  "commandKey": "example"
}

Responses

202

Success

Media typeapplication/json

object

executionId

required

string

>= 1 characters <= 128 characters

commandKey

required

string

>= 1 characters <= 128 characters

sequence

required

integer

<= 9007199254740991

Example ^generated

{
  "executionId": "example",
  "commandKey": "example",
  "sequence": 1
}

400

ChannelInvalid | OrganizationRequired

Media typeapplication/json

Any of:

object

object

_tag

required

string

Allowed values: ChannelInvalid

message

required

string

object

object

_tag

required

string

Allowed values: OrganizationRequired

Example

{
  "_tag": "ChannelInvalid"
}

401

AuthenticationRequired

Media typeapplication/json

object

_tag

required

string

Allowed values: AuthenticationRequired

Example

{
  "_tag": "AuthenticationRequired"
}

403

ExecutionForbidden | @nmnmcc/ability/Authorizer/Forbidden | MembershipRequired | ForbiddenOrigin

Media typeapplication/json

Any of:

object

object

_tag

required

string

Allowed values: ExecutionForbidden

object

object

_tag

required

string

Allowed values: Forbidden

action

required

string

kind

required

string

field

string

reason

string

object

object

_tag

required

string

Allowed values: MembershipRequired

object

object

_tag

required

string

Allowed values: ForbiddenOrigin

Example

{
  "_tag": "ExecutionForbidden"
}

404

ExecutionNotFound | ChannelNotFound | ChannelIdentityNotFound

Media typeapplication/json

Any of:

object

object

_tag

required

string

Allowed values: ExecutionNotFound

id

required

string

>= 1 characters <= 128 characters

object

object

_tag

required

string

Allowed values: ChannelNotFound

id

required

string

object

object

_tag

required

string

Allowed values: ChannelIdentityNotFound

Example

{
  "_tag": "ExecutionNotFound"
}

409

ExecutionConflict | ExecutionKeyConflict | @nmnmcc/ability/Authorizer/Pending | ChannelConflict

Media typeapplication/json

Any of:

object

object

_tag

required

string

Allowed values: ExecutionConflict

id

required

string

>= 1 characters <= 128 characters

object

object

_tag

required

string

Allowed values: ExecutionKeyConflict

object

object

_tag

required

string

Allowed values: Pending

ticket

required

string

reason

string

object

object

_tag

required

string

Allowed values: ChannelConflict

version

required

integer

<= 9007199254740991

Example

{
  "_tag": "ExecutionConflict"
}

429

RateLimited

Media typeapplication/json

object

_tag

required

string

Allowed values: RateLimited

retryAfterSeconds

required

integer

>= -9007199254740991 <= 9007199254740991

Example

{
  "_tag": "RateLimited"
}

503

ExecutionUnavailable | ChannelsUnavailable | AuthenticationUnavailable | RequestFailed

Media typeapplication/json

Any of:

object

object

_tag

required

string

Allowed values: ExecutionUnavailable

errorId

required

string

>= 1 characters <= 128 characters

object

object

_tag

required

string

Allowed values: PolicyUnavailable

object

object

_tag

required

string

Allowed values: ChannelsUnavailable

object

object

_tag

required

string

Allowed values: AuthenticationUnavailable

object

object

_tag

required

string

Allowed values: RequestFailed

category

required

string

Allowed values: invalid forbidden not_found conflict unavailable external outcome_unknown interrupted

errorId

required

string

>= 1 characters <= 128 characters

Example

{
  "_tag": "ExecutionUnavailable"
}