Skip to content

Open Work Direct Message

POST
/work/direct-messages

Open, or return, the direct message with these people and agents. PERSONAL KEY ONLY.

The caller is added server-side, so a body cannot open a conversation between two other people. The id is derived from the participants: asking twice returns the same conversation with duplicate: true. Opening costs nothing; sending to an agent does (see the send operation). Another person’s Chief of Staff is refused, as in the app.

Authorizations

Parameters

Header Parameters

Idempotency-Key
Any of:
string

Retry-safety key. Replaying one returns the ORIGINAL result 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

One direct-message conversation a person is opening.

Names only the OTHER participants: the caller is added server-side from the session, so a body cannot open a conversation between two other people. An empty body is legal only when at least one agent is named — a DM needs two identities in total and the caller is one of them.

object
participantAgentIds
Array<string>
<= 9 items
participantUserIds
Array<string>
<= 9 items

Responses

201

Successful Response

object
data
required

A Work direct message, chat, approval decision, work item, question, rule set or suggestion list, 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