Skip to content

Convert Work Chat

POST
/work/chats/{chat_id}/convert

Turn a chat into a private channel named name, history intact. PERSONAL KEY ONLY.

201 with channel, chatId, agentIds, copiedMessages and duplicate. 404 for a chat that is not the caller’s, 409 when the name is taken or the chat was already converted, 422 for a name that cannot be a channel name.

Authorizations

Parameters

Path Parameters

chat_id
required

Chat id

string

Chat id

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

The channel a chat becomes. The name is normalised like a new channel’s name.

object
displayName
Any of:
string
<= 255 characters
name
required
string
>= 1 characters <= 255 characters

Responses

201

Successful Response

object
data
required

A Work channel, chat, output, task, decision or activity document, as the app returns it.

object
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
notes
Any of:
Array<string>
page
required

Current page number (1-indexed)

integer
total
required

Total number of items

integer
total_available
Any of:
integer
total_is_lower_bound
Any of:
boolean

422

Validation Error

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