Skip to content

Delete Work Channel

DELETE
/work/channels/{channel_id}

Delete one channel for everyone, leaving a non-restorable tombstone.

confirmationName must equal the channel’s own slug. This is not reversible: the room’s history stays as an audit record but nobody can read the channel again. The in-app surface spells this POST /v1/work/channels/{id}/delete; the verb here is DELETE because that is what the operation is and what the scope derived for it means.

Authorizations

Parameters

Path Parameters

channel_id
required

Channel id or slug

string

Channel id or slug

Header Parameters

Idempotency-Key
Any of:
string

Retry-safety key. Replaying one returns the ORIGINAL result with duplicate: true instead of writing twice. Omit it and the server mints a single-use key, which means a retried request writes again — send your own for anything you may retry.

X-Target-Org-Id
Any of:
string

Request Body required

object
confirmationName
required
string
>= 1 characters <= 255 characters

Responses

200

Successful Response

object
data
required

The result of one channel write, with its idempotent-replay marker.

object
canvasSeeded
Any of:
boolean
channel
Any of:

One Work channel as the room stores it.

object
archivedAt
Any of:
string
createdAt
Any of:
string
createdBy
Any of:
string
description
Any of:
string
displayName
Any of:
string
id
Any of:
string
kind
Any of:
string
memberUserIds
Any of:
Array<string>
name
Any of:
string
participantAgentIds
Any of:
Array<string>
system
Any of:
boolean
visibility
Any of:
string
key
additional properties
any
duplicate
Any of:
boolean
key
additional properties
any
pagination
Any of:
object
has_next
required

Whether there are more pages

boolean
limit
required

Items per page

integer
next_cursor
Any of:
string
page
required

Current page number (1-indexed)

integer
total
required

Total number of items

integer

422

Validation Error

object
detail
Array<object>
object
loc
required
Array
msg
required
string
type
required
string