Theme switcher

Move a folder (async)

Header Parameters

Authorizationstring

Path Parameters

folderIdstring Required

Stable folder ID. Unchanged by rename or move. Unknown, malformed, or cross-tenant → 404 FOLDER_NOT_FOUND.

Body Parameters

dataobject Required

Response

202
Object

Move queued for async processing. Poll GET /v2/admin/jobs/{jobId} using data.id (kind: folder.move).

Response Attributes

dataobject Required
400
Object

Destination reference is malformed or ambiguous.

Response Attributes

errorsarray Required
Min items
1
401
Object

Access token is missing or invalid.

Response Attributes

errorsarray Required
Min items
1
403
Object

Authenticated but not permitted — caller is not an admin/super-admin, or the endpoint's feature permission is off.

Response Attributes

errorsarray Required
Min items
1
404
Object

{folderId} or the destination parentId / parentPath is not visible to this caller (unknown, or in another tenant).

Response Attributes

errorsarray Required
Min items
1
409
Object

The move would nest one sync pair inside another (FOLDER_MOVE_SYNC_PAIR_CONFLICT), the folder changed under the request (FOLDER_CONFLICT; safe to retry), or data.type is not folder.

Response Attributes

errorsarray Required
Min items
1
415
Object

Request Content-Type is not application/vnd.api+json.

Response Attributes

errorsarray Required
Min items
1
422
Object

The move is not allowed — see examples for operation-specific codes.

Response Attributes

errorsarray Required
Min items
1
429
Object

Too many requests; retry later.

Response Attributes

errorsarray Required
Min items
1
500
Object

Unexpected server error.

Response Attributes

errorsarray Required
Min items
1
Was this section helpful?

POST

/

Select
1

Response

Was this section helpful?