Skip to main content
Use this endpoint family to fetch one folder, move it in the hierarchy, or delete it.

​
Path Parameters

​
folderId
string
required
Folder ID.

​
Get Folder

cURL
curl --request GET \
  --url https://www.genviral.io/api/partner/v1/folders/{{folder_id}} \
  --header 'Authorization: Bearer <token>'

​
Move Folder

Move to another parent folder by setting parent_folder_id. Set parent_folder_id to null to move to root.
cURL
curl --request PATCH \
  --url https://www.genviral.io/api/partner/v1/folders/{{folder_id}} \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '{
    "parent_folder_id": "aaaaaaaa-aaaa-aaaa-aaaa-aaaaaaaaaaaa"
  }'

​
Delete Folder

Deleting a folder removes its nested children/items by database cascade.
cURL
curl --request DELETE \
  --url https://www.genviral.io/api/partner/v1/folders/{{folder_id}} \
  --header 'Authorization: Bearer <token>'

​
Error Responses

  • 400 missing_folder_id - missing route parameter
  • 400 invalid_json - malformed JSON body for PATCH
  • 422 invalid_path - folderId is not a valid UUID
  • 422 invalid_folder_media_type - folder media type is not supported by Partner folder APIs
  • 404 not_found - folder (or parent folder) not visible in key scope
  • 409 folder_move_conflict - invalid move (self, descendant, or destination name conflict)
  • 422 invalid_payload - PATCH body validation failed
  • 500 folder_get_failed / folder_update_failed / folder_delete_failed - unexpected failure