← 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
| Location | Field | Type | Required | Description |
|---|---|---|---|---|
| Header | Authorization | string | Yes | Credential scoped to the authorized resource. |
| Header | Content-Type | string (media type) | Yes | application/json. |
| Header | Idempotency-Key | string | Yes | Stable retry identity. |
| Body | parent_id | string | Yes | Authorized parent folder. |
| Body | name | string | Yes | Folder 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
| Status | Meaning |
|---|---|
202 Accepted | Success response shown below. |
400 Bad Request | Invalid name or parent. |
401 Unauthorized | Missing, expired, or invalid credential. |
403 Forbidden | Credential is valid but lacks the required scope or role. |
409 Conflict | Idempotency key reused with different input or parent changed. |
429 Too Many Requests | Rate limit reached; honor Retry-After when provided. |
503 Service Unavailable | Service temporarily unavailable; retry safely. |
Response fields
| Field | Type | Example |
|---|---|---|
operation_id | string | op_457 |
folder_id | string | folder_124 |
status | string | accepted |
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.
