Create a todo
POSThttps://
Creates a todo for you against a drive item and returns it with a Location header.
Access
- Token scope
- api:
write: project_management Without it:
403 insufficient-token-scope. - Permission
- project_management::
manage_work_items 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
user_id is always the authenticated caller and cannot be set: there is no way to create a todo for someone else. A drive item you cannot read, or one that is archived, is refused exactly as a nonexistent one is. ⚠ This write is temporary by construction. Todos are a derived copy of document content: the next write to the source drive item (including a title-only PATCH /api/v2/drive-items/{drive_item}) deletes every todo for that item and rebuilds the set from the document HTML, so a todo created here disappears the next time its document is touched. To create a todo that lasts, add an unchecked task item mentioning the user to the document itself.
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 whose document this todo was parsed out of. Writable on create only; a todo cannot be re-parented. No relation object is exposed for it; read the document with GET /api/v2/drive-items/{drive_item}, which applies the drive access rules this collection does not. Archiving a drive item leaves its todos behind, so this id can name an item you can no longer read.
Response 201
Returns a UserTodo 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
The user the todo belongs to. Always the authenticated caller: this collection has no way to read or write another user's todos.
The drive item whose document this todo was parsed out of. Writable on create only; a todo cannot be re-parented. No relation object is exposed for it; read the document with GET /api/v2/drive-items/{drive_item}, which applies the drive access rules this collection does not. Archiving a drive item leaves its todos behind, so this id can name an item you can no longer read.
The user the todo belongs to, always the authenticated caller. Expanding it with ?include=user additionally requires the users::read permission and a token scope covering the users prefix.
Errors
409 Conflict.
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