Update Portal Settings
curl --request PATCH \
--url https://api.conduit.ai/v1/workspaces/{workspace_id}/portal-settings \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"default_stay_template_id": "<string>",
"auto_provision_stay_portals": true,
"default_stripe_connection_id": "<string>",
"stripe_routing_rules": [
{
"targeting": {
"listingIds": [
"<string>"
],
"listingGroupIds": [
"<string>"
]
},
"stripe_connection_id": "<string>"
}
]
}
'import requests
url = "https://api.conduit.ai/v1/workspaces/{workspace_id}/portal-settings"
payload = {
"default_stay_template_id": "<string>",
"auto_provision_stay_portals": True,
"default_stripe_connection_id": "<string>",
"stripe_routing_rules": [
{
"targeting": {
"listingIds": ["<string>"],
"listingGroupIds": ["<string>"]
},
"stripe_connection_id": "<string>"
}
]
}
headers = {
"Authorization": "Bearer <token>",
"Content-Type": "application/json"
}
response = requests.patch(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'PATCH',
headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
body: JSON.stringify({
default_stay_template_id: '<string>',
auto_provision_stay_portals: true,
default_stripe_connection_id: '<string>',
stripe_routing_rules: [
{
targeting: {listingIds: ['<string>'], listingGroupIds: ['<string>']},
stripe_connection_id: '<string>'
}
]
})
};
fetch('https://api.conduit.ai/v1/workspaces/{workspace_id}/portal-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.conduit.ai/v1/workspaces/{workspace_id}/portal-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([
'default_stay_template_id' => '<string>',
'auto_provision_stay_portals' => true,
'default_stripe_connection_id' => '<string>',
'stripe_routing_rules' => [
[
'targeting' => [
'listingIds' => [
'<string>'
],
'listingGroupIds' => [
'<string>'
]
],
'stripe_connection_id' => '<string>'
]
]
]),
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.conduit.ai/v1/workspaces/{workspace_id}/portal-settings"
payload := strings.NewReader("{\n \"default_stay_template_id\": \"<string>\",\n \"auto_provision_stay_portals\": true,\n \"default_stripe_connection_id\": \"<string>\",\n \"stripe_routing_rules\": [\n {\n \"targeting\": {\n \"listingIds\": [\n \"<string>\"\n ],\n \"listingGroupIds\": [\n \"<string>\"\n ]\n },\n \"stripe_connection_id\": \"<string>\"\n }\n ]\n}")
req, _ := http.NewRequest("PATCH", 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.patch("https://api.conduit.ai/v1/workspaces/{workspace_id}/portal-settings")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"default_stay_template_id\": \"<string>\",\n \"auto_provision_stay_portals\": true,\n \"default_stripe_connection_id\": \"<string>\",\n \"stripe_routing_rules\": [\n {\n \"targeting\": {\n \"listingIds\": [\n \"<string>\"\n ],\n \"listingGroupIds\": [\n \"<string>\"\n ]\n },\n \"stripe_connection_id\": \"<string>\"\n }\n ]\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.conduit.ai/v1/workspaces/{workspace_id}/portal-settings")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Patch.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"default_stay_template_id\": \"<string>\",\n \"auto_provision_stay_portals\": true,\n \"default_stripe_connection_id\": \"<string>\",\n \"stripe_routing_rules\": [\n {\n \"targeting\": {\n \"listingIds\": [\n \"<string>\"\n ],\n \"listingGroupIds\": [\n \"<string>\"\n ]\n },\n \"stripe_connection_id\": \"<string>\"\n }\n ]\n}"
response = http.request(request)
puts response.read_body{
"data": {
"workspace_id": "<string>",
"default_stay_template_id": "<string>",
"auto_provision_stay_portals": true,
"default_stripe_connection_id": "<string>",
"stripe_routing_rules": [
{
"targeting": {
"listingIds": [
"<string>"
],
"listingGroupIds": [
"<string>"
]
},
"stripe_connection_id": "<string>"
}
],
"stripe_connections": [
{
"id": "<string>",
"stripe_account_id": "<string>",
"business_name": "<string>",
"country": "<string>",
"default_currency": "<string>",
"charges_enabled": true,
"onboarding_completed": true,
"disconnected": true
}
],
"updated_at": 123
}
}{
"error": "Invalid workspace id"
}{
"error": "Invalid workspace id"
}{
"error": "Invalid workspace id"
}{
"error": "Invalid workspace id"
}{
"error": "Invalid workspace id"
}{
"error": "Invalid workspace id"
}Settings
Update portal settings
Change the default stay template, auto-provisioning, or payment routing.
PATCH
/
v1
/
workspaces
/
{workspace_id}
/
portal-settings
Update Portal Settings
curl --request PATCH \
--url https://api.conduit.ai/v1/workspaces/{workspace_id}/portal-settings \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"default_stay_template_id": "<string>",
"auto_provision_stay_portals": true,
"default_stripe_connection_id": "<string>",
"stripe_routing_rules": [
{
"targeting": {
"listingIds": [
"<string>"
],
"listingGroupIds": [
"<string>"
]
},
"stripe_connection_id": "<string>"
}
]
}
'import requests
url = "https://api.conduit.ai/v1/workspaces/{workspace_id}/portal-settings"
payload = {
"default_stay_template_id": "<string>",
"auto_provision_stay_portals": True,
"default_stripe_connection_id": "<string>",
"stripe_routing_rules": [
{
"targeting": {
"listingIds": ["<string>"],
"listingGroupIds": ["<string>"]
},
"stripe_connection_id": "<string>"
}
]
}
headers = {
"Authorization": "Bearer <token>",
"Content-Type": "application/json"
}
response = requests.patch(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'PATCH',
headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
body: JSON.stringify({
default_stay_template_id: '<string>',
auto_provision_stay_portals: true,
default_stripe_connection_id: '<string>',
stripe_routing_rules: [
{
targeting: {listingIds: ['<string>'], listingGroupIds: ['<string>']},
stripe_connection_id: '<string>'
}
]
})
};
fetch('https://api.conduit.ai/v1/workspaces/{workspace_id}/portal-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.conduit.ai/v1/workspaces/{workspace_id}/portal-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([
'default_stay_template_id' => '<string>',
'auto_provision_stay_portals' => true,
'default_stripe_connection_id' => '<string>',
'stripe_routing_rules' => [
[
'targeting' => [
'listingIds' => [
'<string>'
],
'listingGroupIds' => [
'<string>'
]
],
'stripe_connection_id' => '<string>'
]
]
]),
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.conduit.ai/v1/workspaces/{workspace_id}/portal-settings"
payload := strings.NewReader("{\n \"default_stay_template_id\": \"<string>\",\n \"auto_provision_stay_portals\": true,\n \"default_stripe_connection_id\": \"<string>\",\n \"stripe_routing_rules\": [\n {\n \"targeting\": {\n \"listingIds\": [\n \"<string>\"\n ],\n \"listingGroupIds\": [\n \"<string>\"\n ]\n },\n \"stripe_connection_id\": \"<string>\"\n }\n ]\n}")
req, _ := http.NewRequest("PATCH", 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.patch("https://api.conduit.ai/v1/workspaces/{workspace_id}/portal-settings")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"default_stay_template_id\": \"<string>\",\n \"auto_provision_stay_portals\": true,\n \"default_stripe_connection_id\": \"<string>\",\n \"stripe_routing_rules\": [\n {\n \"targeting\": {\n \"listingIds\": [\n \"<string>\"\n ],\n \"listingGroupIds\": [\n \"<string>\"\n ]\n },\n \"stripe_connection_id\": \"<string>\"\n }\n ]\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.conduit.ai/v1/workspaces/{workspace_id}/portal-settings")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Patch.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"default_stay_template_id\": \"<string>\",\n \"auto_provision_stay_portals\": true,\n \"default_stripe_connection_id\": \"<string>\",\n \"stripe_routing_rules\": [\n {\n \"targeting\": {\n \"listingIds\": [\n \"<string>\"\n ],\n \"listingGroupIds\": [\n \"<string>\"\n ]\n },\n \"stripe_connection_id\": \"<string>\"\n }\n ]\n}"
response = http.request(request)
puts response.read_body{
"data": {
"workspace_id": "<string>",
"default_stay_template_id": "<string>",
"auto_provision_stay_portals": true,
"default_stripe_connection_id": "<string>",
"stripe_routing_rules": [
{
"targeting": {
"listingIds": [
"<string>"
],
"listingGroupIds": [
"<string>"
]
},
"stripe_connection_id": "<string>"
}
],
"stripe_connections": [
{
"id": "<string>",
"stripe_account_id": "<string>",
"business_name": "<string>",
"country": "<string>",
"default_currency": "<string>",
"charges_enabled": true,
"onboarding_completed": true,
"disconnected": true
}
],
"updated_at": 123
}
}{
"error": "Invalid workspace id"
}{
"error": "Invalid workspace id"
}{
"error": "Invalid workspace id"
}{
"error": "Invalid workspace id"
}{
"error": "Invalid workspace id"
}{
"error": "Invalid workspace id"
}Authorizations
Conduit API token. Use Authorization: Bearer <token>. Read/write endpoints require a token with write access.
Path Parameters
Workspace identifier
Minimum string length:
1Body
application/json
Active portal template new stay portals start from. Null restores the built-in default. Requires Manage Portals.
Minimum string length:
1Create a stay portal for every booked reservation. Requires Manage Portals.
Stripe account for payments no routing rule matches. Requires Manage Portal Payments.
Minimum string length:
1Replaces every payment routing rule. The first rule matching the stay's listing chooses the Stripe account. Send [] to remove all rules. Requires Manage Portal Payments.
Maximum array length:
100Show child attributes
Show child attributes
Response
Update Portal Settings
Show child attributes
Show child attributes
Was this page helpful?