curl --request POST \
--url https://api.hyperspell.com/connections/{connection_id}/folder-policies \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"provider_folder_id": "folder_123",
"sync_mode": "sync"
}
'import requests
url = "https://api.hyperspell.com/connections/{connection_id}/folder-policies"
payload = {
"provider_folder_id": "folder_123",
"sync_mode": "sync"
}
headers = {
"Authorization": "Bearer <token>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
body: JSON.stringify({provider_folder_id: 'folder_123', sync_mode: 'sync'})
};
fetch('https://api.hyperspell.com/connections/{connection_id}/folder-policies', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://api.hyperspell.com/connections/{connection_id}/folder-policies",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "POST",
CURLOPT_POSTFIELDS => json_encode([
'provider_folder_id' => 'folder_123',
'sync_mode' => 'sync'
]),
CURLOPT_HTTPHEADER => [
"Authorization: Bearer <token>",
"Content-Type: application/json"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"strings"
"net/http"
"io"
)
func main() {
url := "https://api.hyperspell.com/connections/{connection_id}/folder-policies"
payload := strings.NewReader("{\n \"provider_folder_id\": \"folder_123\",\n \"sync_mode\": \"sync\"\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("Authorization", "Bearer <token>")
req.Header.Add("Content-Type", "application/json")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.post("https://api.hyperspell.com/connections/{connection_id}/folder-policies")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"provider_folder_id\": \"folder_123\",\n \"sync_mode\": \"sync\"\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.hyperspell.com/connections/{connection_id}/folder-policies")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"provider_folder_id\": \"folder_123\",\n \"sync_mode\": \"sync\"\n}"
response = http.request(request)
puts response.read_body{
"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"
}{
"detail": [
{
"loc": [
"<string>"
],
"msg": "<string>",
"type": "<string>"
}
]
}Create a folder policy for a connection
Create or update a folder policy for a specific connection.
curl --request POST \
--url https://api.hyperspell.com/connections/{connection_id}/folder-policies \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"provider_folder_id": "folder_123",
"sync_mode": "sync"
}
'import requests
url = "https://api.hyperspell.com/connections/{connection_id}/folder-policies"
payload = {
"provider_folder_id": "folder_123",
"sync_mode": "sync"
}
headers = {
"Authorization": "Bearer <token>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
body: JSON.stringify({provider_folder_id: 'folder_123', sync_mode: 'sync'})
};
fetch('https://api.hyperspell.com/connections/{connection_id}/folder-policies', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://api.hyperspell.com/connections/{connection_id}/folder-policies",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "POST",
CURLOPT_POSTFIELDS => json_encode([
'provider_folder_id' => 'folder_123',
'sync_mode' => 'sync'
]),
CURLOPT_HTTPHEADER => [
"Authorization: Bearer <token>",
"Content-Type: application/json"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"strings"
"net/http"
"io"
)
func main() {
url := "https://api.hyperspell.com/connections/{connection_id}/folder-policies"
payload := strings.NewReader("{\n \"provider_folder_id\": \"folder_123\",\n \"sync_mode\": \"sync\"\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("Authorization", "Bearer <token>")
req.Header.Add("Content-Type", "application/json")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.post("https://api.hyperspell.com/connections/{connection_id}/folder-policies")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"provider_folder_id\": \"folder_123\",\n \"sync_mode\": \"sync\"\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.hyperspell.com/connections/{connection_id}/folder-policies")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"provider_folder_id\": \"folder_123\",\n \"sync_mode\": \"sync\"\n}"
response = http.request(request)
puts response.read_body{
"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"
}{
"detail": [
{
"loc": [
"<string>"
],
"msg": "<string>",
"type": "<string>"
}
]
}Authorizations
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.
Headers
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
Path Parameters
Body
Folder ID from the source provider
Sync mode for this folder
sync, skip, manual Display name of the folder
Display path of the folder
Parent folder's provider ID for inheritance resolution
Response
Successful Response
Unique policy ID
Folder ID from the source provider
Sync mode for this folder
sync, skip, manual Display name of the folder
Display path of the folder
Parent folder's provider ID
Connection ID (null for integration defaults)
Was this page helpful?