Skip to content

Edit Work Message

PATCH
/work/messages/{message_id}

Correct a message this credential authored.

Deliberately not a re-send: no agent turn runs again and nobody is notified, so an agent that already acted on the first wording is not run twice. Pass expected_revision to make the edit conditional on the version you read.

Authorizations

Parameters

Path Parameters

message_id
required

Message id

string

Message 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

New words for a message the caller wrote. Never who wrote it, or where.

object
document
Any of:
object
key
additional properties
any
expected_revision
integer
default: 1 >= 1
text
Any of:
string
<= 12000 characters

Responses

200

Successful Response

object
data
required

One stored Work message.

object
author
Any of:
object
key
additional properties
any
channel
Any of:
string
createdAt
Any of:
string
document
Any of:
object
key
additional properties
any
id
Any of:
string
text
Any of:
string
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