Update connection settings
curl --request PATCH \
--url https://api.ofauth.com/v2/account/connections/{connectionId}/settings \
--header 'Content-Type: application/json' \
--header 'apiKey: <api-key>' \
--data '
{
"vaultPlus": {
"enabled": true,
"settings": {
"autoCacheVault": true,
"autoCacheMessages": true,
"autoCachePosts": true,
"autoCacheStories": true,
"minAccessCountVault": 123,
"minAccessCountMessages": 123,
"minAccessCountPosts": 123,
"minAccessCountStories": 123,
"cacheImages": true,
"cacheVideos": true,
"cacheAudio": true,
"imageQualities": [],
"videoQualities": [],
"retentionDays": 123,
"accessExpiryDays": 123,
"presignedUrlTtlSeconds": 123,
"storageLimitBytes": 123
}
},
"liveEvents": {
"enabled": true,
"enabledPayloadKeys": [
"<string>"
]
}
}
'import requests
url = "https://api.ofauth.com/v2/account/connections/{connectionId}/settings"
payload = {
"vaultPlus": {
"enabled": True,
"settings": {
"autoCacheVault": True,
"autoCacheMessages": True,
"autoCachePosts": True,
"autoCacheStories": True,
"minAccessCountVault": 123,
"minAccessCountMessages": 123,
"minAccessCountPosts": 123,
"minAccessCountStories": 123,
"cacheImages": True,
"cacheVideos": True,
"cacheAudio": True,
"imageQualities": [],
"videoQualities": [],
"retentionDays": 123,
"accessExpiryDays": 123,
"presignedUrlTtlSeconds": 123,
"storageLimitBytes": 123
}
},
"liveEvents": {
"enabled": True,
"enabledPayloadKeys": ["<string>"]
}
}
headers = {
"apiKey": "<api-key>",
"Content-Type": "application/json"
}
response = requests.patch(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'PATCH',
headers: {apiKey: '<api-key>', 'Content-Type': 'application/json'},
body: JSON.stringify({
vaultPlus: {
enabled: true,
settings: {
autoCacheVault: true,
autoCacheMessages: true,
autoCachePosts: true,
autoCacheStories: true,
minAccessCountVault: 123,
minAccessCountMessages: 123,
minAccessCountPosts: 123,
minAccessCountStories: 123,
cacheImages: true,
cacheVideos: true,
cacheAudio: true,
imageQualities: [],
videoQualities: [],
retentionDays: 123,
accessExpiryDays: 123,
presignedUrlTtlSeconds: 123,
storageLimitBytes: 123
}
},
liveEvents: {enabled: true, enabledPayloadKeys: ['<string>']}
})
};
fetch('https://api.ofauth.com/v2/account/connections/{connectionId}/settings', 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.ofauth.com/v2/account/connections/{connectionId}/settings",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "PATCH",
CURLOPT_POSTFIELDS => json_encode([
'vaultPlus' => [
'enabled' => true,
'settings' => [
'autoCacheVault' => true,
'autoCacheMessages' => true,
'autoCachePosts' => true,
'autoCacheStories' => true,
'minAccessCountVault' => 123,
'minAccessCountMessages' => 123,
'minAccessCountPosts' => 123,
'minAccessCountStories' => 123,
'cacheImages' => true,
'cacheVideos' => true,
'cacheAudio' => true,
'imageQualities' => [
],
'videoQualities' => [
],
'retentionDays' => 123,
'accessExpiryDays' => 123,
'presignedUrlTtlSeconds' => 123,
'storageLimitBytes' => 123
]
],
'liveEvents' => [
'enabled' => true,
'enabledPayloadKeys' => [
'<string>'
]
]
]),
CURLOPT_HTTPHEADER => [
"Content-Type: application/json",
"apiKey: <api-key>"
],
]);
$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.ofauth.com/v2/account/connections/{connectionId}/settings"
payload := strings.NewReader("{\n \"vaultPlus\": {\n \"enabled\": true,\n \"settings\": {\n \"autoCacheVault\": true,\n \"autoCacheMessages\": true,\n \"autoCachePosts\": true,\n \"autoCacheStories\": true,\n \"minAccessCountVault\": 123,\n \"minAccessCountMessages\": 123,\n \"minAccessCountPosts\": 123,\n \"minAccessCountStories\": 123,\n \"cacheImages\": true,\n \"cacheVideos\": true,\n \"cacheAudio\": true,\n \"imageQualities\": [],\n \"videoQualities\": [],\n \"retentionDays\": 123,\n \"accessExpiryDays\": 123,\n \"presignedUrlTtlSeconds\": 123,\n \"storageLimitBytes\": 123\n }\n },\n \"liveEvents\": {\n \"enabled\": true,\n \"enabledPayloadKeys\": [\n \"<string>\"\n ]\n }\n}")
req, _ := http.NewRequest("PATCH", url, payload)
req.Header.Add("apiKey", "<api-key>")
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.patch("https://api.ofauth.com/v2/account/connections/{connectionId}/settings")
.header("apiKey", "<api-key>")
.header("Content-Type", "application/json")
.body("{\n \"vaultPlus\": {\n \"enabled\": true,\n \"settings\": {\n \"autoCacheVault\": true,\n \"autoCacheMessages\": true,\n \"autoCachePosts\": true,\n \"autoCacheStories\": true,\n \"minAccessCountVault\": 123,\n \"minAccessCountMessages\": 123,\n \"minAccessCountPosts\": 123,\n \"minAccessCountStories\": 123,\n \"cacheImages\": true,\n \"cacheVideos\": true,\n \"cacheAudio\": true,\n \"imageQualities\": [],\n \"videoQualities\": [],\n \"retentionDays\": 123,\n \"accessExpiryDays\": 123,\n \"presignedUrlTtlSeconds\": 123,\n \"storageLimitBytes\": 123\n }\n },\n \"liveEvents\": {\n \"enabled\": true,\n \"enabledPayloadKeys\": [\n \"<string>\"\n ]\n }\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.ofauth.com/v2/account/connections/{connectionId}/settings")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Patch.new(url)
request["apiKey"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"vaultPlus\": {\n \"enabled\": true,\n \"settings\": {\n \"autoCacheVault\": true,\n \"autoCacheMessages\": true,\n \"autoCachePosts\": true,\n \"autoCacheStories\": true,\n \"minAccessCountVault\": 123,\n \"minAccessCountMessages\": 123,\n \"minAccessCountPosts\": 123,\n \"minAccessCountStories\": 123,\n \"cacheImages\": true,\n \"cacheVideos\": true,\n \"cacheAudio\": true,\n \"imageQualities\": [],\n \"videoQualities\": [],\n \"retentionDays\": 123,\n \"accessExpiryDays\": 123,\n \"presignedUrlTtlSeconds\": 123,\n \"storageLimitBytes\": 123\n }\n },\n \"liveEvents\": {\n \"enabled\": true,\n \"enabledPayloadKeys\": [\n \"<string>\"\n ]\n }\n}"
response = http.request(request)
puts response.read_body{
"settings": {
"connectionId": "<string>",
"liveEvents": {
"enabled": true,
"enabledPayloadKeys": [
"<string>"
]
},
"vaultPlus": {
"enabled": true,
"settingsOverrides": {
"autoCacheVault": true,
"autoCacheMessages": true,
"autoCachePosts": true,
"autoCacheStories": true,
"minAccessCountVault": 123,
"minAccessCountMessages": 123,
"minAccessCountPosts": 123,
"minAccessCountStories": 123,
"cacheImages": true,
"cacheVideos": true,
"cacheAudio": true,
"imageQualities": [],
"videoQualities": [],
"retentionDays": 123,
"accessExpiryDays": 123,
"presignedUrlTtlSeconds": 123,
"storageLimitBytes": 123
},
"stats": {
"vaultPlusEnabled": true,
"totalStorageBytes": 123,
"storageLimitBytes": 123,
"mediaCount": 123,
"storedCount": 123,
"storageUsagePercent": 123
}
}
},
"purgeResult": {
"purgedCount": 123,
"freedBytes": 123
}
}Connections
Update connection settings
Update settings for a specific connection. Set vaultPlus.enabled to toggle vault caching. Set vaultPlus.settings to override org defaults (null to reset to org defaults).
PATCH
/
v2
/
account
/
connections
/
{connectionId}
/
settings
Update connection settings
curl --request PATCH \
--url https://api.ofauth.com/v2/account/connections/{connectionId}/settings \
--header 'Content-Type: application/json' \
--header 'apiKey: <api-key>' \
--data '
{
"vaultPlus": {
"enabled": true,
"settings": {
"autoCacheVault": true,
"autoCacheMessages": true,
"autoCachePosts": true,
"autoCacheStories": true,
"minAccessCountVault": 123,
"minAccessCountMessages": 123,
"minAccessCountPosts": 123,
"minAccessCountStories": 123,
"cacheImages": true,
"cacheVideos": true,
"cacheAudio": true,
"imageQualities": [],
"videoQualities": [],
"retentionDays": 123,
"accessExpiryDays": 123,
"presignedUrlTtlSeconds": 123,
"storageLimitBytes": 123
}
},
"liveEvents": {
"enabled": true,
"enabledPayloadKeys": [
"<string>"
]
}
}
'import requests
url = "https://api.ofauth.com/v2/account/connections/{connectionId}/settings"
payload = {
"vaultPlus": {
"enabled": True,
"settings": {
"autoCacheVault": True,
"autoCacheMessages": True,
"autoCachePosts": True,
"autoCacheStories": True,
"minAccessCountVault": 123,
"minAccessCountMessages": 123,
"minAccessCountPosts": 123,
"minAccessCountStories": 123,
"cacheImages": True,
"cacheVideos": True,
"cacheAudio": True,
"imageQualities": [],
"videoQualities": [],
"retentionDays": 123,
"accessExpiryDays": 123,
"presignedUrlTtlSeconds": 123,
"storageLimitBytes": 123
}
},
"liveEvents": {
"enabled": True,
"enabledPayloadKeys": ["<string>"]
}
}
headers = {
"apiKey": "<api-key>",
"Content-Type": "application/json"
}
response = requests.patch(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'PATCH',
headers: {apiKey: '<api-key>', 'Content-Type': 'application/json'},
body: JSON.stringify({
vaultPlus: {
enabled: true,
settings: {
autoCacheVault: true,
autoCacheMessages: true,
autoCachePosts: true,
autoCacheStories: true,
minAccessCountVault: 123,
minAccessCountMessages: 123,
minAccessCountPosts: 123,
minAccessCountStories: 123,
cacheImages: true,
cacheVideos: true,
cacheAudio: true,
imageQualities: [],
videoQualities: [],
retentionDays: 123,
accessExpiryDays: 123,
presignedUrlTtlSeconds: 123,
storageLimitBytes: 123
}
},
liveEvents: {enabled: true, enabledPayloadKeys: ['<string>']}
})
};
fetch('https://api.ofauth.com/v2/account/connections/{connectionId}/settings', 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.ofauth.com/v2/account/connections/{connectionId}/settings",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "PATCH",
CURLOPT_POSTFIELDS => json_encode([
'vaultPlus' => [
'enabled' => true,
'settings' => [
'autoCacheVault' => true,
'autoCacheMessages' => true,
'autoCachePosts' => true,
'autoCacheStories' => true,
'minAccessCountVault' => 123,
'minAccessCountMessages' => 123,
'minAccessCountPosts' => 123,
'minAccessCountStories' => 123,
'cacheImages' => true,
'cacheVideos' => true,
'cacheAudio' => true,
'imageQualities' => [
],
'videoQualities' => [
],
'retentionDays' => 123,
'accessExpiryDays' => 123,
'presignedUrlTtlSeconds' => 123,
'storageLimitBytes' => 123
]
],
'liveEvents' => [
'enabled' => true,
'enabledPayloadKeys' => [
'<string>'
]
]
]),
CURLOPT_HTTPHEADER => [
"Content-Type: application/json",
"apiKey: <api-key>"
],
]);
$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.ofauth.com/v2/account/connections/{connectionId}/settings"
payload := strings.NewReader("{\n \"vaultPlus\": {\n \"enabled\": true,\n \"settings\": {\n \"autoCacheVault\": true,\n \"autoCacheMessages\": true,\n \"autoCachePosts\": true,\n \"autoCacheStories\": true,\n \"minAccessCountVault\": 123,\n \"minAccessCountMessages\": 123,\n \"minAccessCountPosts\": 123,\n \"minAccessCountStories\": 123,\n \"cacheImages\": true,\n \"cacheVideos\": true,\n \"cacheAudio\": true,\n \"imageQualities\": [],\n \"videoQualities\": [],\n \"retentionDays\": 123,\n \"accessExpiryDays\": 123,\n \"presignedUrlTtlSeconds\": 123,\n \"storageLimitBytes\": 123\n }\n },\n \"liveEvents\": {\n \"enabled\": true,\n \"enabledPayloadKeys\": [\n \"<string>\"\n ]\n }\n}")
req, _ := http.NewRequest("PATCH", url, payload)
req.Header.Add("apiKey", "<api-key>")
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.patch("https://api.ofauth.com/v2/account/connections/{connectionId}/settings")
.header("apiKey", "<api-key>")
.header("Content-Type", "application/json")
.body("{\n \"vaultPlus\": {\n \"enabled\": true,\n \"settings\": {\n \"autoCacheVault\": true,\n \"autoCacheMessages\": true,\n \"autoCachePosts\": true,\n \"autoCacheStories\": true,\n \"minAccessCountVault\": 123,\n \"minAccessCountMessages\": 123,\n \"minAccessCountPosts\": 123,\n \"minAccessCountStories\": 123,\n \"cacheImages\": true,\n \"cacheVideos\": true,\n \"cacheAudio\": true,\n \"imageQualities\": [],\n \"videoQualities\": [],\n \"retentionDays\": 123,\n \"accessExpiryDays\": 123,\n \"presignedUrlTtlSeconds\": 123,\n \"storageLimitBytes\": 123\n }\n },\n \"liveEvents\": {\n \"enabled\": true,\n \"enabledPayloadKeys\": [\n \"<string>\"\n ]\n }\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.ofauth.com/v2/account/connections/{connectionId}/settings")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Patch.new(url)
request["apiKey"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"vaultPlus\": {\n \"enabled\": true,\n \"settings\": {\n \"autoCacheVault\": true,\n \"autoCacheMessages\": true,\n \"autoCachePosts\": true,\n \"autoCacheStories\": true,\n \"minAccessCountVault\": 123,\n \"minAccessCountMessages\": 123,\n \"minAccessCountPosts\": 123,\n \"minAccessCountStories\": 123,\n \"cacheImages\": true,\n \"cacheVideos\": true,\n \"cacheAudio\": true,\n \"imageQualities\": [],\n \"videoQualities\": [],\n \"retentionDays\": 123,\n \"accessExpiryDays\": 123,\n \"presignedUrlTtlSeconds\": 123,\n \"storageLimitBytes\": 123\n }\n },\n \"liveEvents\": {\n \"enabled\": true,\n \"enabledPayloadKeys\": [\n \"<string>\"\n ]\n }\n}"
response = http.request(request)
puts response.read_body{
"settings": {
"connectionId": "<string>",
"liveEvents": {
"enabled": true,
"enabledPayloadKeys": [
"<string>"
]
},
"vaultPlus": {
"enabled": true,
"settingsOverrides": {
"autoCacheVault": true,
"autoCacheMessages": true,
"autoCachePosts": true,
"autoCacheStories": true,
"minAccessCountVault": 123,
"minAccessCountMessages": 123,
"minAccessCountPosts": 123,
"minAccessCountStories": 123,
"cacheImages": true,
"cacheVideos": true,
"cacheAudio": true,
"imageQualities": [],
"videoQualities": [],
"retentionDays": 123,
"accessExpiryDays": 123,
"presignedUrlTtlSeconds": 123,
"storageLimitBytes": 123
},
"stats": {
"vaultPlusEnabled": true,
"totalStorageBytes": 123,
"storageLimitBytes": 123,
"mediaCount": 123,
"storedCount": 123,
"storageUsagePercent": 123
}
}
},
"purgeResult": {
"purgedCount": 123,
"freedBytes": 123
}
}Path Parameters
Was this page helpful?
⌘I