---
title: "Call board.write_document"
method: POST
path: "/api/v1/tools/board.write_document"
tags: ["board"]
---

# Call board.write_document

`POST /api/v1/tools/board.write_document`

## Request

- Base URL: `https://app.goosybear.ai`
- URL: `https://app.goosybear.ai/api/v1/tools/board.write_document`
- Auth: HTTP bearer

'put the call script on the sales board', 'replace the Gravity call script with this version', 'update the onboarding doc' — create one document on a board of this workspace, or replace one in place. Without document_id it creates a new document on the board; with the document_id an earlier call returned it replaces that document's title and whole text and keeps its id, so publishing a new version never adds a duplicate. Pass the updated_at the last answer returned as expected_updated_at: a document a member saved since is refused and left unchanged. A replace overwrites the previous title and text, which cannot be brought back. It answers the document's id, its new updated_at and the path a member opens it at. Not for drafting an article that opens the Splash Pad's article workflow — that is `splash_pad.write_article`.

Every result names the workspace it ran in. Say which workspace the answer is about. When the account has more than one workspace and none is selected, this tool refuses with `workspace_ambiguous` and lists the choices — offer them, never pick one.

## Headers

- `x-request-id` string

## Request body

- object
  - `board_id` string, uuid, required: The board the document is on, or goes on, as `board.tree` returned it.
  - `document_id` string, uuid: The document to replace, as an earlier `board.write_document` returned it. Omit to create a new document on the board.
  - `title` string, required: The document's title, replacing any title it had.
  - `body_markdown` string, required: The whole document in markdown, replacing everything it held. Headings, bold, italic, lists and links are kept; anything else arrives as its text.
  - `expected_updated_at` string: With document_id only: the updated_at an earlier answer returned. A document saved since is refused and left unchanged. Omit to replace it as it reads now.
  - `workspace` string: Which workspace to run in — its slug. Omit to use your default. With more than one reachable workspace and no default, the call is refused and the choices are listed.

## Response `200`

The call was admitted and dispatched. `ok` says whether the tool succeeded — a refusal the tool itself produced is still a 200, exactly as it is a successful JSON-RPC result over MCP.

- union
  - object: The tool ran and answered.
    - `ok` true, required
    - `document_id` string, uuid, required
    - `board_id` string, uuid, required
    - `title` string, required
    - `updated_at` string, required: The document's version after this write; pass it as expected_updated_at to replace it again safely.
    - `created` boolean, required: true when this call made the document, false when it replaced one.
    - `url` string, required: Where a member opens the document in the product, as a path: a Splash Pad document opens in its article workflow, any other on its board.
    - `workspace` string, required: The slug of the workspace this call ran in.
    - `working_in` object, required: Which workspace this call ran in, and how that was decided. Present on every workspace-scoped result.
      - `label` string, required: The chip words — e.g. "working in: Acme Main".
      - `note` string, required: Why this workspace — e.g. "your default", "this call only".
      - `workspace` string, required: The resolved workspace's slug.
      - `source` 'call-override' | 'key-pin' | 'stored-default' | 'sole-reachable', required: Which rung of the R7 precedence resolved the workspace.
  - ToolRefusal: A call that was admitted and dispatched, and did not succeed.
    - `ok` false, required
    - `code` string, required: The typed reason — e.g. `workspace_ambiguous`, `invalid_arguments`, or the tool's own failure code.
    - `message` string, required: A sentence a person can act on.
    - `workspaces` string[]: On a workspace refusal: the slugs this key may pass as `workspace`.
    - `issues` object[]: On `invalid_arguments`: which fields failed, and why.
      - `path` string, required
      - `message` string, required
    - `path` string: On an authoring refusal: where in your call's input it points, e.g. `steps.<key>.params.<field>`.
    - `fix` string: On an authoring refusal: the change to your call that would pass.
    - `instruction` string: On an authoring refusal: what to do next with it.

## Other responses

- `400`: The request could not be used: the body is present but not a JSON object (`tenant_api.malformed_body`); it is a top-level array carrying more messages than this endpoint accepts (`tenant_mcp.batch_too_large`); or the `Idempotency-Key` header is malformed (`tenant_api.idempotency_key_invalid`), disagrees with the body's `idempotency_key` (`tenant_api.idempotency_key_conflict`), or was sent to an action that cannot replay a retry (`tenant_api.idempotency_unsupported`). Nothing ran.
- `401`: No bearer credential, or one that did not resolve. Deliberately ONE undifferentiated answer for absent / unknown / revoked / expired, so the endpoint is never an oracle over the key space.
- `403`: The credential is good but the surface is not open to it — the platform or account API switch is off, or the holder lacks the `api.access` capability. The `code` says which.
- `404`: No such tool. The body names no tool and is identical for every unrecognised name.
- `429`: Over this key's per-minute cap. Carries `Retry-After` and `error.retry_after_seconds`.

---

[API](https://skmtc.dev/goosybear/apis/goosy-bear-api.md) · [All operations](https://skmtc.dev/goosybear/apis/goosy-bear-api/llms.txt) · [OpenAPI document](https://skmtc.dev/goosybear/apis/goosy-bear-api/revisions/6d82fb124064?raw)