Skip to main content
POST
Accept a suggestion

Authorizations

scribe_session
string
cookie
required

Browser session cookie set by the WorkOS sign-in flow.

Path Parameters

id
string
required

Id of the suggestion thread to accept.

Body

application/json

Optional accept options; omit for the default server-side transform.

Options for resolving a suggestion. The body is optional; an empty or missing body keeps the default server-side behavior.

clientApplied
boolean

Set to true when the calling editor already applied the accept/reject transform to the collaborative document locally (so the edit sits in its undo history); the server then skips the document transform and only records the status change. Omit it (the default) to have the document transformed server-side — the right choice for API callers and agents.

Example:

false

Response

The suggestion was processed.

Result of accepting a suggestion.

applied
boolean
required

Whether the proposed text was applied to the document.

Example:

true

thread
object
required

A comment or suggestion thread anchored to a document range.

Example: