Create a document body
POSThttps://
Gives an existing bodyless drive item a body, and returns it with a Location header.
Access
- Token scope
- api:
write: orapi:project_drive write: orapi:customer_drive write: orapi:organization_drive write: user_drive Without it:
403 insufficient-token-scope. - Permission
- project_drive::
create Without it:
403 insufficient-permission. - Rate cost
- 1 unit, write bucket. A write costs the same whatever
viewyou ask for. - Also
- Accepts
Idempotency-Key. Never cached:private, no-store. Unknown body keys are refused, never dropped.
Both are checked, scope first. A token never does more than its user. How access is checked
This is the second half of creating a document: POST /api/v2/drive-items creates the item, and this endpoint fills it in. content is GitHub-Flavored Markdown and may be omitted for an empty document. Two refusals: an item that already has a body answers 409 duplicate-resource, because a drive item has at most one, and an item that is not an editable document (an uploaded PDF, image or Office file) answers 422 on /drive_item_id, since there is no editor schema to hold a body. An item the caller cannot read is refused exactly as a nonexistent one is. Because the body did not exist a moment ago, no collaboration room can be open on it, so the content is stored directly and the editor adopts it on first open. The declared permission is project_drive::create; the other three drive prefixes apply by the owning item's owner type, and the record rule, edit access on that item, is what actually decides.
Query parameters
Unknown parameters are refused with 400, naming the parameter.
Request headers
A correlation id of your own. It is recorded in our logs next to the server's request id but never returned: the response header always carries the server's id. A value that does not match the pattern is discarded silently, never rejected.
Request body
Unknown keys are refused with 422, naming the key.
The drive item this body belongs to. Set on create and immutable afterwards; read the item itself from GET /api/v2/drive-items/{drive_item}.
The document body as GitHub-Flavored Markdown: headings, lists, task lists (- [ ]), tables, code fences, links and images all survive. Detail-only: pass ?view=detail to get it on the collection. Markdown cannot express text colours, highlights, alignment or @mentions, so read ?include=content_html first if the document may contain them: a read of content followed by a PATCH of it discards all four permanently.
Response 201
Returns a DriveDocument in the detail view.
Headers
ETag- A strong validator of exactly this representation.
Idempotency-Replayedtruewhen this response was replayed from a storedIdempotency-Keyrather than produced by a new write.Location- The absolute URL of the created or queued resource.
RateLimit- The IETF
httpapi-ratelimit-headersform of your remaining allowance on the tightest bucket this request touched. RateLimit-Policy- The ceiling and window of that bucket, as
<limit>;w=<seconds>. X-Request-Id- The server-generated ULID correlating this response with our logs.
Every response also carries Cache-Control, Vary, X-Content-Type-Options, X-Plnnrly-Api-Version, X-RateLimit-Limit, X-RateLimit-Remaining, X-RateLimit-Reset. Headers and versioning
Id of the document body, not of the drive item it belongs to. The two are numbered separately.
The drive item this body belongs to. Set on create and immutable afterwards; read the item itself from GET /api/v2/drive-items/{drive_item}.
The document body as GitHub-Flavored Markdown: headings, lists, task lists (- [ ]), tables, code fences, links and images all survive. Detail-only: pass ?view=detail to get it on the collection. Markdown cannot express text colours, highlights, alignment or @mentions, so read ?include=content_html first if the document may contain them: a read of content followed by a PATCH of it discards all four permanently.
Last-write timestamp; use for incremental sync. Typing in the collaborative editor moves this, not the drive item's own updated_at.
Errors
415 Unsupported media type.
422 Unprocessable content.
7 errors every operation can return: 400, 401, 404, 406, 429, 500, 503
400 Bad request.
idempotency-key-requiredinvalid-cursorinvalid-query-parametermalformed-requestunsupported-parameter
401 Unauthenticated.
404 Not found.
406 Not acceptable.
429 Too many requests.
500 Server error.
503 Service unavailable.
This path allows GET, POST. Anything else answers 405.
Something wrong or missing on this page? Tell us