Skip to main content
POST
/
connections
/
{connection_id}
/
folder-policies
JavaScript
import Hyperspell from 'hyperspell';

const client = new Hyperspell({
  apiKey: process.env['HYPERSPELL_API_KEY'], // This is the default and can be omitted
});

const response = await client.folders.setPolicies('182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e', {
  provider_folder_id: 'provider_folder_id',
  sync_mode: 'sync',
});

console.log(response.id);
{
  "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "provider_folder_id": "<string>",
  "sync_mode": "sync",
  "folder_name": "<string>",
  "folder_path": "<string>",
  "parent_folder_id": "<string>",
  "connection_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a"
}

Authorizations

Authorization
string
header
required

API Key or JWT User Token. If using an API Key, set the X-As-User header to act as a specific user. A JWT User Token is always scoped to a specific user.

Path Parameters

connection_id
string<uuid>
required

Body

application/json
provider_folder_id
string
required

Folder ID from the source provider

sync_mode
enum<string>
required

Sync mode for this folder

Available options:
sync,
skip,
manual
folder_name
string | null

Display name of the folder

folder_path
string | null

Display path of the folder

parent_folder_id
string | null

Parent folder's provider ID for inheritance resolution

Response

Successful Response

id
string<uuid>
required

Unique policy ID

provider_folder_id
string
required

Folder ID from the source provider

sync_mode
enum<string>
required

Sync mode for this folder

Available options:
sync,
skip,
manual
folder_name
string | null

Display name of the folder

folder_path
string | null

Display path of the folder

parent_folder_id
string | null

Parent folder's provider ID

connection_id
string<uuid> | null

Connection ID (null for integration defaults)