HYhyperspell
Folder Policies

Create a folder policy for a connection

Create or update a folder policy for a specific connection.

post/connections/{connection_id}/folder-policies

Request

  • Base URL
    https://api.hyperspell.com
  • URL
    https://api.hyperspell.com/connections/{connection_id}/folder-policies
  • Auth
    HTTP bearer

Path parameters

connection_idstring uuid required

Headers

X-As-Userstring nullable

Optionally set this header to act as a specific user when using an API Key, equivalent to first exchanging the API Key for a User Token

Request body

provider_folder_idstring required

Folder ID from the source provider

folder_namestring nullable

Display name of the folder

folder_pathstring nullable

Display path of the folder

parent_folder_idstring nullable

Parent folder's provider ID for inheritance resolution

sync_mode'sync' | 'skip' | 'manual' required

Example request

{
  "provider_folder_id": "folder_123",
  "sync_mode": "sync"
}

Response

Successful Response

idstring uuid required

Unique policy ID

provider_folder_idstring required

Folder ID from the source provider

folder_namestring nullable

Display name of the folder

folder_pathstring nullable

Display path of the folder

parent_folder_idstring nullable

Parent folder's provider ID

sync_mode'sync' | 'skip' | 'manual' required
connection_idstring uuid nullable

Connection ID (null for integration defaults)

Changes

No operation changes recorded.