Skip to main content
POST
Post a message to a document

Authorizations

Authorization
string
header
required

API key, e.g. Authorization: Bearer sajn_svc_.... Not scope-limited: acts with its owner's workspace role.

Scopes

documents:write

Create documents and edit the documents the user created.

Headers

Sajn-Version
enum<string>

API version for this request. Without it, the request uses the organization's default version; an organization without a default is pinned to the latest version by its first request.

Available options:
2026-09,
2026-10
Sajn-Workspace
string

ID of the workspace this request acts in, from GET /api/v1/workspaces. Without it, an API key acts in its default workspace. The token's user must be a member of the workspace; an OAuth token only accepts the workspace it was granted for. A workspace that doesn't exist or can't be reached returns 403 WORKSPACE_ACCESS_DENIED.

Idempotency-Key
string

Makes retries safe. A retry with the same key and the same request replays the stored response for 24 hours (header Idempotent-Replayed: true); the same key with a different request returns 400.

Maximum string length: 255

Path Parameters

id
string
required

The document ID.

Body

application/json

Body

body
string
required

The message text, up to 2,000 characters.

Required string length: 1 - 2000
internal
boolean
default:false

When true the message is internal (visible only to workspace members). When false (default) it is external — visible to the document signers and triggers their email notifications.

Response

200

id
string
required

The message ID.

documentId
string
required

The document ID.

body
string
required

The message text.

internal
boolean
required

true = internal (workspace-only); false = external (visible to signers, sends notifications)

createdAt
string<date-time>
required

When the message was created.

updatedAt
string<date-time>
required

When the message was last updated.

author
object | null
required

Who wrote the message. Null when the author no longer exists.