Skip to content

Create Work Chat

POST
/work/chats

Open a new chat with the caller’s Chief of Staff and the operator bench. PERSONAL KEY ONLY.

201 with directMessage (a chat IS a direct-message conversation; its payload carries workChat) and duplicate. With initialMessage the first message is posted in the same request and the Chief’s turn STARTS, which SPENDS credits; the body then also carries message. A replayed Idempotency-Key returns the same chat; a new key opens a new one. 503 while chats are switched off.

Authorizations

Parameters

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 new chat. It names nothing but an optional title, a first message and a subject.

object
initialMessage
Any of:
object
key
additional properties
any
subject
Any of:

The record a chat is about.

object
id
required
string
>= 1 characters <= 64 characters
kind
required
string
Allowed values: deal company desk_card
title
Any of:
string
<= 4000 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