Skip to content

Update Work Chat

PATCH
/work/chats/{chat_id}

Rename a chat and/or archive or restore it for the caller. PERSONAL KEY ONLY.

Archive is per person; rename is for everyone. Send title, archived, or both. 404 for a chat that is not the caller’s, 409 once it became a channel, 422 for an empty 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

A rename and/or an archive change. A field left out is left alone; at least one is required.

object
archived
Any of:
boolean
title
Any of:
string
<= 1000 characters

Responses

200

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