Document overwrite
/v1/documents/{id}/overwrite
Signed-in sessionLaunch key product.editorOperation document_overwrite
People plan work as projects with tasks, sprints, a board, a backlog, a timeline and a dashboard, and write shared documents in one editor with history and media.
Headers
- X-Specify-Account-IdstringRequired
- The account the request acts in.
- X-Specify-Service-Tenancy-IdstringRequired
- The service tenancy the request acts in.
Path parameters
- idstringRequired
Body
- expectedAuthorizationVersionstring
- inputstring
- documentFormat2
Returns
- canEditfalse | true
- documentobject
- minAvailableVersionnumber
- archivedboolean
- leaseobject
- scopeobject
- headJsonstring
- clientIdstring
- itemsany | object[]
- cursorany | null | string
- kind"page" | "resync" | "accepted" | "conflict"
- commitsobject[] | any
- nextVersionnumber | any
- epochnumber
- schemaFingerprintstring
- pmSchemaVersion1 | 2
- markdownDialectVersion1
- fromVersionnumber
- toVersionnumber
- afterHashstring
- resultobject
- headVersionnumber
- resultVersion1
- operation"append" | "import" | "remap" | "name" | "overwrite" | "publish" | "restore"
- unresolvedCountnumber
- revisionobject
- publicationIdstring
- memoryIdstring
- memoryVersionnumber
- supersedesMemoryIdnull | string
Errors
400, 401, 403, 404, 409, 429 and 503 return {"error": {"code", "message", "correlationId"}}. A call without a valid credential gets 401 before its input is checked, and so does an address that is not an operation: 404 and 400 come only once the credential is accepted. Public operations answer without one.