/developers
Developer docsAtom Files ↗
← API referenceOrganize · API access unavailable
API REFERENCE / ORGANIZE

PATCH /v1/items/{item_id}

Rename or move a file or folder using an expected metadata revision.

Request fields

LocationFieldTypeRequiredDescription
HeaderAuthorizationstringYesCredential scoped to the authorized resource.
HeaderContent-Typestring (media type)Yesapplication/json.
Pathitem_idstringYesStable file or folder ID.
HeaderIdempotency-KeystringYesStable retry identity.
Bodyexpected_revisionstringYesRevision observed before editing.
BodynamestringNoNew name.
Bodyparent_idstringNoAuthorized destination folder.

Request example

Example request
PATCH /v1/items/file_789
Authorization: Bearer <scoped token>
Idempotency-Key: move-8427
Content-Type: application/json

{
  "expected_revision": "rev_007",
  "name": "invoice-final.pdf",
  "parent_id": "folder_124"
}

HTTP status codes

StatusMeaning
202 AcceptedSuccess response shown below.
400 Bad RequestInvalid name or destination.
401 UnauthorizedMissing, expired, or invalid credential.
403 ForbiddenCredential is valid but lacks the required scope or role.
404 Not FoundItem is not visible.
409 ConflictExpected revision changed.
429 Too Many RequestsRate limit reached; honor Retry-After when provided.
503 Service UnavailableService temporarily unavailable; retry safely.

Response fields

FieldTypeExample
operation_idstringop_458
item_idstringfile_789
statusstringaccepted

Response example

Example response
202 Accepted
Content-Type: application/json

{
  "operation_id": "op_458",
  "item_id": "file_789",
  "status": "accepted"
}

How it works

This endpoint changes metadata or placement, not immutable file bytes. An absent or stale expected revision must never silently overwrite a concurrent edit. Cross-provider moves may be asynchronous.