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

POST /v1/folders

Create a child folder under an authorized parent using a retry-safe intent.

Request fields

LocationFieldTypeRequiredDescription
HeaderAuthorizationstringYesCredential scoped to the authorized resource.
HeaderContent-Typestring (media type)Yesapplication/json.
HeaderIdempotency-KeystringYesStable retry identity.
Bodyparent_idstringYesAuthorized parent folder.
BodynamestringYesFolder name.

Request example

Example request
POST /v1/folders
Authorization: Bearer <scoped token>
Idempotency-Key: folder-8427
Content-Type: application/json

{
  "parent_id": "folder_123",
  "name": "Receipts"
}

HTTP status codes

StatusMeaning
202 AcceptedSuccess response shown below.
400 Bad RequestInvalid name or parent.
401 UnauthorizedMissing, expired, or invalid credential.
403 ForbiddenCredential is valid but lacks the required scope or role.
409 ConflictIdempotency key reused with different input or parent changed.
429 Too Many RequestsRate limit reached; honor Retry-After when provided.
503 Service UnavailableService temporarily unavailable; retry safely.

Response fields

FieldTypeExample
operation_idstringop_457
folder_idstringfolder_124
statusstringaccepted

Response example

Example response
202 Accepted
Content-Type: application/json

{
  "operation_id": "op_457",
  "folder_id": "folder_124",
  "status": "accepted"
}

How it works

The operation becomes available only after its destination commits and returns a receipt. A lost response is recovered using the same Idempotency-Key.