---
title: "Edit Work Message"
method: PATCH
path: "/work/messages/{message_id}"
tags: ["Work"]
---

# Edit Work Message

`PATCH /work/messages/{message_id}`

## Request

- Base URL: `https://be.graph8.com/api/v1`
- URL: `https://be.graph8.com/api/v1/work/messages/{message_id}`
- Auth: HTTP bearer

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.

## Path parameters

- `message_id` string, required: Message id

## Headers

- `Idempotency-Key` string, nullable: 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.
- `Authorization` string, nullable
- `X-Target-Org-Id` string, nullable

## Request body

- WorkMessageEditRequest: New words for a message the caller wrote. Never who wrote it, or where.
  - `text` string, nullable
  - `document` object, nullable
  - `expected_revision` integer

## Response `200`

Successful Response

- ApiResponseWorkMessage
  - `data` WorkMessage, required: One stored Work message.
    - `id` string, nullable: Message id
    - `channel` string, nullable: Conversation address — a channel NAME or a direct-message id
    - `document` object, nullable: Rich-text document, normalized server-side
    - `text` string, nullable: Plain-text projection of the document
    - `author` object, nullable: Resolved author — always the authenticated principal, never a request field
    - `createdAt` string, nullable: Creation timestamp
  - `pagination` PaginationMeta
    - `page` integer, required: Current page number (1-indexed)
    - `limit` integer, required: Items per page
    - `total` integer, required: Total number of items
    - `has_next` boolean, required: Whether there are more pages
    - `next_cursor` string, nullable: Opaque cursor for the next page; null when there are no more items. Pass it back as the `cursor` query param to fetch the following page without computing page numbers.
    - `total_available` integer, nullable: Search endpoints only: how many records really match, when known. Can be larger than `total`, which is capped at the 10,000 results that can be paged. For company search this is a distinct-company estimate. Null when unknown; absent outside search.
    - `total_is_lower_bound` boolean, nullable: Search endpoints only: true when more records match than `total` shows (the result set is larger than the 10,000 results that can be paged). Absent outside search.
    - `notes` string[], nullable: Search endpoints only: plain-language notes about the result, e.g. that more records match than can be paged, or that a reversed `between` range was put in order.

## Other responses

- `422`: Validation Error

---

[API](https://skmtc.dev/graph8/apis/graph8-developer-api.md) · [All operations](https://skmtc.dev/graph8/apis/graph8-developer-api/llms.txt) · [OpenAPI document](https://skmtc.dev/graph8/apis/graph8-developer-api/revisions/2e7cfa0ca921?raw)