Create Portal Offer
curl --request POST \
--url https://api.conduit.ai/v1/workspaces/{workspace_id}/portal-offers \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"name": "<string>",
"description": "<string>",
"price_in_cents": 1,
"compare_at_price_in_cents": 1,
"image_url": "<string>",
"background_hex": "<string>",
"category": "<string>",
"link_url": "<string>",
"highlights": [
"<string>"
],
"availability": {
"visibleFrom": 1,
"visibleUntil": 1,
"bookableFrom": 1,
"bookableUntil": 1
},
"targeting": {
"bookingChannels": [
"<string>"
],
"minNights": 1,
"maxNights": 1,
"minVacantNightsBeforeArrival": 1,
"minVacantNightsAfterDeparture": 1,
"listingIds": [
"<string>"
],
"listingGroupIds": [
"<string>"
],
"inboxTypeIds": [
"<string>"
]
}
}
'import requests
url = "https://api.conduit.ai/v1/workspaces/{workspace_id}/portal-offers"
payload = {
"name": "<string>",
"description": "<string>",
"price_in_cents": 1,
"compare_at_price_in_cents": 1,
"image_url": "<string>",
"background_hex": "<string>",
"category": "<string>",
"link_url": "<string>",
"highlights": ["<string>"],
"availability": {
"visibleFrom": 1,
"visibleUntil": 1,
"bookableFrom": 1,
"bookableUntil": 1
},
"targeting": {
"bookingChannels": ["<string>"],
"minNights": 1,
"maxNights": 1,
"minVacantNightsBeforeArrival": 1,
"minVacantNightsAfterDeparture": 1,
"listingIds": ["<string>"],
"listingGroupIds": ["<string>"],
"inboxTypeIds": ["<string>"]
}
}
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>',
description: '<string>',
price_in_cents: 1,
compare_at_price_in_cents: 1,
image_url: '<string>',
background_hex: '<string>',
category: '<string>',
link_url: '<string>',
highlights: ['<string>'],
availability: {visibleFrom: 1, visibleUntil: 1, bookableFrom: 1, bookableUntil: 1},
targeting: {
bookingChannels: ['<string>'],
minNights: 1,
maxNights: 1,
minVacantNightsBeforeArrival: 1,
minVacantNightsAfterDeparture: 1,
listingIds: ['<string>'],
listingGroupIds: ['<string>'],
inboxTypeIds: ['<string>']
}
})
};
fetch('https://api.conduit.ai/v1/workspaces/{workspace_id}/portal-offers', 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-offers",
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>',
'description' => '<string>',
'price_in_cents' => 1,
'compare_at_price_in_cents' => 1,
'image_url' => '<string>',
'background_hex' => '<string>',
'category' => '<string>',
'link_url' => '<string>',
'highlights' => [
'<string>'
],
'availability' => [
'visibleFrom' => 1,
'visibleUntil' => 1,
'bookableFrom' => 1,
'bookableUntil' => 1
],
'targeting' => [
'bookingChannels' => [
'<string>'
],
'minNights' => 1,
'maxNights' => 1,
'minVacantNightsBeforeArrival' => 1,
'minVacantNightsAfterDeparture' => 1,
'listingIds' => [
'<string>'
],
'listingGroupIds' => [
'<string>'
],
'inboxTypeIds' => [
'<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-offers"
payload := strings.NewReader("{\n \"name\": \"<string>\",\n \"description\": \"<string>\",\n \"price_in_cents\": 1,\n \"compare_at_price_in_cents\": 1,\n \"image_url\": \"<string>\",\n \"background_hex\": \"<string>\",\n \"category\": \"<string>\",\n \"link_url\": \"<string>\",\n \"highlights\": [\n \"<string>\"\n ],\n \"availability\": {\n \"visibleFrom\": 1,\n \"visibleUntil\": 1,\n \"bookableFrom\": 1,\n \"bookableUntil\": 1\n },\n \"targeting\": {\n \"bookingChannels\": [\n \"<string>\"\n ],\n \"minNights\": 1,\n \"maxNights\": 1,\n \"minVacantNightsBeforeArrival\": 1,\n \"minVacantNightsAfterDeparture\": 1,\n \"listingIds\": [\n \"<string>\"\n ],\n \"listingGroupIds\": [\n \"<string>\"\n ],\n \"inboxTypeIds\": [\n \"<string>\"\n ]\n }\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}/portal-offers")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"name\": \"<string>\",\n \"description\": \"<string>\",\n \"price_in_cents\": 1,\n \"compare_at_price_in_cents\": 1,\n \"image_url\": \"<string>\",\n \"background_hex\": \"<string>\",\n \"category\": \"<string>\",\n \"link_url\": \"<string>\",\n \"highlights\": [\n \"<string>\"\n ],\n \"availability\": {\n \"visibleFrom\": 1,\n \"visibleUntil\": 1,\n \"bookableFrom\": 1,\n \"bookableUntil\": 1\n },\n \"targeting\": {\n \"bookingChannels\": [\n \"<string>\"\n ],\n \"minNights\": 1,\n \"maxNights\": 1,\n \"minVacantNightsBeforeArrival\": 1,\n \"minVacantNightsAfterDeparture\": 1,\n \"listingIds\": [\n \"<string>\"\n ],\n \"listingGroupIds\": [\n \"<string>\"\n ],\n \"inboxTypeIds\": [\n \"<string>\"\n ]\n }\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.conduit.ai/v1/workspaces/{workspace_id}/portal-offers")
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 \"description\": \"<string>\",\n \"price_in_cents\": 1,\n \"compare_at_price_in_cents\": 1,\n \"image_url\": \"<string>\",\n \"background_hex\": \"<string>\",\n \"category\": \"<string>\",\n \"link_url\": \"<string>\",\n \"highlights\": [\n \"<string>\"\n ],\n \"availability\": {\n \"visibleFrom\": 1,\n \"visibleUntil\": 1,\n \"bookableFrom\": 1,\n \"bookableUntil\": 1\n },\n \"targeting\": {\n \"bookingChannels\": [\n \"<string>\"\n ],\n \"minNights\": 1,\n \"maxNights\": 1,\n \"minVacantNightsBeforeArrival\": 1,\n \"minVacantNightsAfterDeparture\": 1,\n \"listingIds\": [\n \"<string>\"\n ],\n \"listingGroupIds\": [\n \"<string>\"\n ],\n \"inboxTypeIds\": [\n \"<string>\"\n ]\n }\n}"
response = http.request(request)
puts response.read_body{
"data": {
"id": "<string>",
"workspace_id": "<string>",
"name": "<string>",
"description": "<string>",
"price_in_cents": 123,
"currency": "<string>",
"active": true,
"created_at": 123,
"updated_at": 123,
"percent_price": {
"percent": 50
},
"compare_at_price_in_cents": 123,
"image_url": "<string>",
"image_attribution": {
"source": "unsplash",
"photographerName": "<string>",
"photographerUrl": "<string>",
"photoUrl": "<string>"
},
"background_hex": "<string>",
"category": "<string>",
"pricing": {
"model": "flat"
},
"link_url": "<string>",
"highlights": [
"<string>"
],
"availability": {
"visibleFrom": 1,
"visibleUntil": 1,
"bookableFrom": 1,
"bookableUntil": 1
},
"targeting": {
"bookingChannels": [
"<string>"
],
"minNights": 1,
"maxNights": 1,
"minVacantNightsBeforeArrival": 1,
"minVacantNightsAfterDeparture": 1,
"listingIds": [
"<string>"
],
"listingGroupIds": [
"<string>"
],
"inboxTypeIds": [
"<string>"
],
"customAttributeConditions": {
"conditions": [
{
"attributeId": "<string>",
"value": "<string>"
}
]
}
},
"sku": "<string>"
}
}{
"error": "Invalid workspace id"
}{
"error": "Invalid workspace id"
}{
"error": "Invalid workspace id"
}{
"error": "Invalid workspace id"
}{
"error": "Invalid workspace id"
}{
"error": "Invalid workspace id"
}Offers
Create Portal Offer
Create an active portal offer for a workspace.
POST
/
v1
/
workspaces
/
{workspace_id}
/
portal-offers
Create Portal Offer
curl --request POST \
--url https://api.conduit.ai/v1/workspaces/{workspace_id}/portal-offers \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"name": "<string>",
"description": "<string>",
"price_in_cents": 1,
"compare_at_price_in_cents": 1,
"image_url": "<string>",
"background_hex": "<string>",
"category": "<string>",
"link_url": "<string>",
"highlights": [
"<string>"
],
"availability": {
"visibleFrom": 1,
"visibleUntil": 1,
"bookableFrom": 1,
"bookableUntil": 1
},
"targeting": {
"bookingChannels": [
"<string>"
],
"minNights": 1,
"maxNights": 1,
"minVacantNightsBeforeArrival": 1,
"minVacantNightsAfterDeparture": 1,
"listingIds": [
"<string>"
],
"listingGroupIds": [
"<string>"
],
"inboxTypeIds": [
"<string>"
]
}
}
'import requests
url = "https://api.conduit.ai/v1/workspaces/{workspace_id}/portal-offers"
payload = {
"name": "<string>",
"description": "<string>",
"price_in_cents": 1,
"compare_at_price_in_cents": 1,
"image_url": "<string>",
"background_hex": "<string>",
"category": "<string>",
"link_url": "<string>",
"highlights": ["<string>"],
"availability": {
"visibleFrom": 1,
"visibleUntil": 1,
"bookableFrom": 1,
"bookableUntil": 1
},
"targeting": {
"bookingChannels": ["<string>"],
"minNights": 1,
"maxNights": 1,
"minVacantNightsBeforeArrival": 1,
"minVacantNightsAfterDeparture": 1,
"listingIds": ["<string>"],
"listingGroupIds": ["<string>"],
"inboxTypeIds": ["<string>"]
}
}
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>',
description: '<string>',
price_in_cents: 1,
compare_at_price_in_cents: 1,
image_url: '<string>',
background_hex: '<string>',
category: '<string>',
link_url: '<string>',
highlights: ['<string>'],
availability: {visibleFrom: 1, visibleUntil: 1, bookableFrom: 1, bookableUntil: 1},
targeting: {
bookingChannels: ['<string>'],
minNights: 1,
maxNights: 1,
minVacantNightsBeforeArrival: 1,
minVacantNightsAfterDeparture: 1,
listingIds: ['<string>'],
listingGroupIds: ['<string>'],
inboxTypeIds: ['<string>']
}
})
};
fetch('https://api.conduit.ai/v1/workspaces/{workspace_id}/portal-offers', 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-offers",
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>',
'description' => '<string>',
'price_in_cents' => 1,
'compare_at_price_in_cents' => 1,
'image_url' => '<string>',
'background_hex' => '<string>',
'category' => '<string>',
'link_url' => '<string>',
'highlights' => [
'<string>'
],
'availability' => [
'visibleFrom' => 1,
'visibleUntil' => 1,
'bookableFrom' => 1,
'bookableUntil' => 1
],
'targeting' => [
'bookingChannels' => [
'<string>'
],
'minNights' => 1,
'maxNights' => 1,
'minVacantNightsBeforeArrival' => 1,
'minVacantNightsAfterDeparture' => 1,
'listingIds' => [
'<string>'
],
'listingGroupIds' => [
'<string>'
],
'inboxTypeIds' => [
'<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-offers"
payload := strings.NewReader("{\n \"name\": \"<string>\",\n \"description\": \"<string>\",\n \"price_in_cents\": 1,\n \"compare_at_price_in_cents\": 1,\n \"image_url\": \"<string>\",\n \"background_hex\": \"<string>\",\n \"category\": \"<string>\",\n \"link_url\": \"<string>\",\n \"highlights\": [\n \"<string>\"\n ],\n \"availability\": {\n \"visibleFrom\": 1,\n \"visibleUntil\": 1,\n \"bookableFrom\": 1,\n \"bookableUntil\": 1\n },\n \"targeting\": {\n \"bookingChannels\": [\n \"<string>\"\n ],\n \"minNights\": 1,\n \"maxNights\": 1,\n \"minVacantNightsBeforeArrival\": 1,\n \"minVacantNightsAfterDeparture\": 1,\n \"listingIds\": [\n \"<string>\"\n ],\n \"listingGroupIds\": [\n \"<string>\"\n ],\n \"inboxTypeIds\": [\n \"<string>\"\n ]\n }\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}/portal-offers")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"name\": \"<string>\",\n \"description\": \"<string>\",\n \"price_in_cents\": 1,\n \"compare_at_price_in_cents\": 1,\n \"image_url\": \"<string>\",\n \"background_hex\": \"<string>\",\n \"category\": \"<string>\",\n \"link_url\": \"<string>\",\n \"highlights\": [\n \"<string>\"\n ],\n \"availability\": {\n \"visibleFrom\": 1,\n \"visibleUntil\": 1,\n \"bookableFrom\": 1,\n \"bookableUntil\": 1\n },\n \"targeting\": {\n \"bookingChannels\": [\n \"<string>\"\n ],\n \"minNights\": 1,\n \"maxNights\": 1,\n \"minVacantNightsBeforeArrival\": 1,\n \"minVacantNightsAfterDeparture\": 1,\n \"listingIds\": [\n \"<string>\"\n ],\n \"listingGroupIds\": [\n \"<string>\"\n ],\n \"inboxTypeIds\": [\n \"<string>\"\n ]\n }\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.conduit.ai/v1/workspaces/{workspace_id}/portal-offers")
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 \"description\": \"<string>\",\n \"price_in_cents\": 1,\n \"compare_at_price_in_cents\": 1,\n \"image_url\": \"<string>\",\n \"background_hex\": \"<string>\",\n \"category\": \"<string>\",\n \"link_url\": \"<string>\",\n \"highlights\": [\n \"<string>\"\n ],\n \"availability\": {\n \"visibleFrom\": 1,\n \"visibleUntil\": 1,\n \"bookableFrom\": 1,\n \"bookableUntil\": 1\n },\n \"targeting\": {\n \"bookingChannels\": [\n \"<string>\"\n ],\n \"minNights\": 1,\n \"maxNights\": 1,\n \"minVacantNightsBeforeArrival\": 1,\n \"minVacantNightsAfterDeparture\": 1,\n \"listingIds\": [\n \"<string>\"\n ],\n \"listingGroupIds\": [\n \"<string>\"\n ],\n \"inboxTypeIds\": [\n \"<string>\"\n ]\n }\n}"
response = http.request(request)
puts response.read_body{
"data": {
"id": "<string>",
"workspace_id": "<string>",
"name": "<string>",
"description": "<string>",
"price_in_cents": 123,
"currency": "<string>",
"active": true,
"created_at": 123,
"updated_at": 123,
"percent_price": {
"percent": 50
},
"compare_at_price_in_cents": 123,
"image_url": "<string>",
"image_attribution": {
"source": "unsplash",
"photographerName": "<string>",
"photographerUrl": "<string>",
"photoUrl": "<string>"
},
"background_hex": "<string>",
"category": "<string>",
"pricing": {
"model": "flat"
},
"link_url": "<string>",
"highlights": [
"<string>"
],
"availability": {
"visibleFrom": 1,
"visibleUntil": 1,
"bookableFrom": 1,
"bookableUntil": 1
},
"targeting": {
"bookingChannels": [
"<string>"
],
"minNights": 1,
"maxNights": 1,
"minVacantNightsBeforeArrival": 1,
"minVacantNightsAfterDeparture": 1,
"listingIds": [
"<string>"
],
"listingGroupIds": [
"<string>"
],
"inboxTypeIds": [
"<string>"
],
"customAttributeConditions": {
"conditions": [
{
"attributeId": "<string>",
"value": "<string>"
}
]
}
},
"sku": "<string>"
}
}{
"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
Minimum string length:
1Required range:
x >= 0Show child attributes
Show child attributes
Required range:
x >= 0Show child attributes
Show child attributes
Pattern:
^#?[0-9a-fA-F]{6}$Available options:
purchase, request, ad Show child attributes
Show child attributes
Show child attributes
Show child attributes
Show child attributes
Show child attributes
Response
Create Portal Offer
Show child attributes
Show child attributes
Was this page helpful?
⌘I