Skip to main content
POST
Reset Paragraph Contents (Dev Only)

Authorizations

Authorization
string
header
required

API key in format {id}.{secret}.

The notes an endpoint returns depend on the key type. A user key reaches the notes that user can see in the app, including notes in their own private folders. A system key (workspace or organization, no user identity) reaches only notes that sit in a folder shared with all workspace members. Notes in a private folder, in a folder shared with only some members, or in no folder at all fall outside a system key's read scope, and scopes do not widen that boundary.

List and search endpoints drop out-of-scope notes from the response without an error. Single-note reads and their sub-resources return 404, the same response as a deleted note. See What notes a system key reads.

Path Parameters

noteGuid
string
required

GUID of the note whose paragraphs are reset.

Body

application/json
kind
enum<string>
required

Content kind to reset across every paragraph.

Available options:
original,
translated,
summary
Example:

"original"

etag
string
required

Exact editState.etag from the latest paragraph read response.

Minimum string length: 1
Example:

"value-from-read-response"

Response

Reset completed. Returns the new etag with undoAvailable and canReset set to false for this command target. Read the paragraphs again for updated content and availability for other actions.

etag
string
required

Opaque token for the updated content state. Never derive or increment this value.

undoAvailable
boolean
required

Whether Undo is available for the command target. False after reset.

canReset
boolean
required

Whether reset is available for the command target. False after reset.