curl --request POST \
--url https://api.conduit.ai/v1/workspaces/{workspace_id}/verification-rules \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"name": "<string>",
"config": {},
"targeting": {
"bookingChannels": [
"<string>"
],
"minNights": 1,
"maxNights": 1,
"maxBookingLeadDays": 1,
"matchUnknownBookingLeadTime": true,
"listingIds": [
"<string>"
],
"listingGroupIds": [
"<string>"
]
},
"exclude_returning_guests": true,
"enabled": true
}
'import requests
url = "https://api.conduit.ai/v1/workspaces/{workspace_id}/verification-rules"
payload = {
"name": "<string>",
"config": {},
"targeting": {
"bookingChannels": ["<string>"],
"minNights": 1,
"maxNights": 1,
"maxBookingLeadDays": 1,
"matchUnknownBookingLeadTime": True,
"listingIds": ["<string>"],
"listingGroupIds": ["<string>"]
},
"exclude_returning_guests": True,
"enabled": True
}
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({
name: '<string>',
config: {},
targeting: {
bookingChannels: ['<string>'],
minNights: 1,
maxNights: 1,
maxBookingLeadDays: 1,
matchUnknownBookingLeadTime: true,
listingIds: ['<string>'],
listingGroupIds: ['<string>']
},
exclude_returning_guests: true,
enabled: true
})
};
fetch('https://api.conduit.ai/v1/workspaces/{workspace_id}/verification-rules', 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}/verification-rules",
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([
'name' => '<string>',
'config' => [
],
'targeting' => [
'bookingChannels' => [
'<string>'
],
'minNights' => 1,
'maxNights' => 1,
'maxBookingLeadDays' => 1,
'matchUnknownBookingLeadTime' => true,
'listingIds' => [
'<string>'
],
'listingGroupIds' => [
'<string>'
]
],
'exclude_returning_guests' => true,
'enabled' => true
]),
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}/verification-rules"
payload := strings.NewReader("{\n \"name\": \"<string>\",\n \"config\": {},\n \"targeting\": {\n \"bookingChannels\": [\n \"<string>\"\n ],\n \"minNights\": 1,\n \"maxNights\": 1,\n \"maxBookingLeadDays\": 1,\n \"matchUnknownBookingLeadTime\": true,\n \"listingIds\": [\n \"<string>\"\n ],\n \"listingGroupIds\": [\n \"<string>\"\n ]\n },\n \"exclude_returning_guests\": true,\n \"enabled\": true\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.conduit.ai/v1/workspaces/{workspace_id}/verification-rules")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"name\": \"<string>\",\n \"config\": {},\n \"targeting\": {\n \"bookingChannels\": [\n \"<string>\"\n ],\n \"minNights\": 1,\n \"maxNights\": 1,\n \"maxBookingLeadDays\": 1,\n \"matchUnknownBookingLeadTime\": true,\n \"listingIds\": [\n \"<string>\"\n ],\n \"listingGroupIds\": [\n \"<string>\"\n ]\n },\n \"exclude_returning_guests\": true,\n \"enabled\": true\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.conduit.ai/v1/workspaces/{workspace_id}/verification-rules")
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 \"name\": \"<string>\",\n \"config\": {},\n \"targeting\": {\n \"bookingChannels\": [\n \"<string>\"\n ],\n \"minNights\": 1,\n \"maxNights\": 1,\n \"maxBookingLeadDays\": 1,\n \"matchUnknownBookingLeadTime\": true,\n \"listingIds\": [\n \"<string>\"\n ],\n \"listingGroupIds\": [\n \"<string>\"\n ]\n },\n \"exclude_returning_guests\": true,\n \"enabled\": true\n}"
response = http.request(request)
puts response.read_body{
"data": {
"id": "<string>",
"workspace_id": "<string>",
"name": "<string>",
"enabled": true,
"order": 123,
"targeting": {
"bookingChannels": [
"<string>"
],
"minNights": 1,
"maxNights": 1,
"maxBookingLeadDays": 1,
"matchUnknownBookingLeadTime": true,
"listingIds": [
"<string>"
],
"listingGroupIds": [
"<string>"
]
},
"config": {
"title": "<string>",
"instructions": "<string>",
"requireContactPhoto": true,
"autoApprove": true,
"provider": "<string>"
},
"created_at": 123,
"updated_at": 123,
"exclude_returning_guests": true
}
}{
"error": "Invalid workspace id"
}{
"error": "Invalid workspace id"
}{
"error": "Invalid workspace id"
}{
"error": "Invalid workspace id"
}{
"error": "Invalid workspace id"
}{
"error": "Invalid workspace id"
}Create Verification Rule
Create a portal verification rule for a workspace.
curl --request POST \
--url https://api.conduit.ai/v1/workspaces/{workspace_id}/verification-rules \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"name": "<string>",
"config": {},
"targeting": {
"bookingChannels": [
"<string>"
],
"minNights": 1,
"maxNights": 1,
"maxBookingLeadDays": 1,
"matchUnknownBookingLeadTime": true,
"listingIds": [
"<string>"
],
"listingGroupIds": [
"<string>"
]
},
"exclude_returning_guests": true,
"enabled": true
}
'import requests
url = "https://api.conduit.ai/v1/workspaces/{workspace_id}/verification-rules"
payload = {
"name": "<string>",
"config": {},
"targeting": {
"bookingChannels": ["<string>"],
"minNights": 1,
"maxNights": 1,
"maxBookingLeadDays": 1,
"matchUnknownBookingLeadTime": True,
"listingIds": ["<string>"],
"listingGroupIds": ["<string>"]
},
"exclude_returning_guests": True,
"enabled": True
}
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({
name: '<string>',
config: {},
targeting: {
bookingChannels: ['<string>'],
minNights: 1,
maxNights: 1,
maxBookingLeadDays: 1,
matchUnknownBookingLeadTime: true,
listingIds: ['<string>'],
listingGroupIds: ['<string>']
},
exclude_returning_guests: true,
enabled: true
})
};
fetch('https://api.conduit.ai/v1/workspaces/{workspace_id}/verification-rules', 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}/verification-rules",
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([
'name' => '<string>',
'config' => [
],
'targeting' => [
'bookingChannels' => [
'<string>'
],
'minNights' => 1,
'maxNights' => 1,
'maxBookingLeadDays' => 1,
'matchUnknownBookingLeadTime' => true,
'listingIds' => [
'<string>'
],
'listingGroupIds' => [
'<string>'
]
],
'exclude_returning_guests' => true,
'enabled' => true
]),
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}/verification-rules"
payload := strings.NewReader("{\n \"name\": \"<string>\",\n \"config\": {},\n \"targeting\": {\n \"bookingChannels\": [\n \"<string>\"\n ],\n \"minNights\": 1,\n \"maxNights\": 1,\n \"maxBookingLeadDays\": 1,\n \"matchUnknownBookingLeadTime\": true,\n \"listingIds\": [\n \"<string>\"\n ],\n \"listingGroupIds\": [\n \"<string>\"\n ]\n },\n \"exclude_returning_guests\": true,\n \"enabled\": true\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.conduit.ai/v1/workspaces/{workspace_id}/verification-rules")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"name\": \"<string>\",\n \"config\": {},\n \"targeting\": {\n \"bookingChannels\": [\n \"<string>\"\n ],\n \"minNights\": 1,\n \"maxNights\": 1,\n \"maxBookingLeadDays\": 1,\n \"matchUnknownBookingLeadTime\": true,\n \"listingIds\": [\n \"<string>\"\n ],\n \"listingGroupIds\": [\n \"<string>\"\n ]\n },\n \"exclude_returning_guests\": true,\n \"enabled\": true\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.conduit.ai/v1/workspaces/{workspace_id}/verification-rules")
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 \"name\": \"<string>\",\n \"config\": {},\n \"targeting\": {\n \"bookingChannels\": [\n \"<string>\"\n ],\n \"minNights\": 1,\n \"maxNights\": 1,\n \"maxBookingLeadDays\": 1,\n \"matchUnknownBookingLeadTime\": true,\n \"listingIds\": [\n \"<string>\"\n ],\n \"listingGroupIds\": [\n \"<string>\"\n ]\n },\n \"exclude_returning_guests\": true,\n \"enabled\": true\n}"
response = http.request(request)
puts response.read_body{
"data": {
"id": "<string>",
"workspace_id": "<string>",
"name": "<string>",
"enabled": true,
"order": 123,
"targeting": {
"bookingChannels": [
"<string>"
],
"minNights": 1,
"maxNights": 1,
"maxBookingLeadDays": 1,
"matchUnknownBookingLeadTime": true,
"listingIds": [
"<string>"
],
"listingGroupIds": [
"<string>"
]
},
"config": {
"title": "<string>",
"instructions": "<string>",
"requireContactPhoto": true,
"autoApprove": true,
"provider": "<string>"
},
"created_at": 123,
"updated_at": 123,
"exclude_returning_guests": true
}
}{
"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
1Body
Operator-facing rule name
1id_check, agreement, damage_waiver, security_deposit, mandatory_fee, guest_details, additional_questions, other_guests Shape depends on step_type. id_check: {title, instructions, requireContactPhoto?, autoApprove?}. agreement: {title, body}. damage_waiver: {title, body, pricing?}. security_deposit: {title, instructions, amountInCents, currency, releaseDelayDays?}. mandatory_fee: {title, instructions, amountInCents, currency}. guest_details: {title, description?, collectEmail, collectPhone, collectEta, collectEtd, requiredFields}. additional_questions: {title, description?, questions}. other_guests: {title, description?, minGuests?, maxGuests?, fields?}.
Show child attributes
Show child attributes
Which stays this rule applies to. Omit to target every stay.
Show child attributes
Show child attributes
Defaults to true. Disabled rules never apply.
Response
Create Verification Rule
Show child attributes
Show child attributes
Was this page helpful?