Create Portal Guide
curl --request POST \
--url https://api.conduit.ai/v1/workspaces/{workspace_id}/portal-guides \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"title": "<string>",
"description": "<string>",
"category": "<string>",
"cover_image_url": "<string>",
"blocks": [
{
"kind": "text",
"id": "<string>",
"body": "<string>",
"title": "<string>"
}
],
"targeting": {
"listingIds": [
"<string>"
],
"listingGroupIds": [
"<string>"
]
},
"show_after_check_in_only": true
}
'import requests
url = "https://api.conduit.ai/v1/workspaces/{workspace_id}/portal-guides"
payload = {
"title": "<string>",
"description": "<string>",
"category": "<string>",
"cover_image_url": "<string>",
"blocks": [
{
"kind": "text",
"id": "<string>",
"body": "<string>",
"title": "<string>"
}
],
"targeting": {
"listingIds": ["<string>"],
"listingGroupIds": ["<string>"]
},
"show_after_check_in_only": 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({
title: '<string>',
description: '<string>',
category: '<string>',
cover_image_url: '<string>',
blocks: [
{
kind: 'text',
id: '<string>',
body: JSON.stringify('<string>'),
title: '<string>'
}
],
targeting: {listingIds: ['<string>'], listingGroupIds: ['<string>']},
show_after_check_in_only: true
})
};
fetch('https://api.conduit.ai/v1/workspaces/{workspace_id}/portal-guides', 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-guides",
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([
'title' => '<string>',
'description' => '<string>',
'category' => '<string>',
'cover_image_url' => '<string>',
'blocks' => [
[
'kind' => 'text',
'id' => '<string>',
'body' => '<string>',
'title' => '<string>'
]
],
'targeting' => [
'listingIds' => [
'<string>'
],
'listingGroupIds' => [
'<string>'
]
],
'show_after_check_in_only' => 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}/portal-guides"
payload := strings.NewReader("{\n \"title\": \"<string>\",\n \"description\": \"<string>\",\n \"category\": \"<string>\",\n \"cover_image_url\": \"<string>\",\n \"blocks\": [\n {\n \"kind\": \"text\",\n \"id\": \"<string>\",\n \"body\": \"<string>\",\n \"title\": \"<string>\"\n }\n ],\n \"targeting\": {\n \"listingIds\": [\n \"<string>\"\n ],\n \"listingGroupIds\": [\n \"<string>\"\n ]\n },\n \"show_after_check_in_only\": 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}/portal-guides")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"title\": \"<string>\",\n \"description\": \"<string>\",\n \"category\": \"<string>\",\n \"cover_image_url\": \"<string>\",\n \"blocks\": [\n {\n \"kind\": \"text\",\n \"id\": \"<string>\",\n \"body\": \"<string>\",\n \"title\": \"<string>\"\n }\n ],\n \"targeting\": {\n \"listingIds\": [\n \"<string>\"\n ],\n \"listingGroupIds\": [\n \"<string>\"\n ]\n },\n \"show_after_check_in_only\": true\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.conduit.ai/v1/workspaces/{workspace_id}/portal-guides")
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 \"title\": \"<string>\",\n \"description\": \"<string>\",\n \"category\": \"<string>\",\n \"cover_image_url\": \"<string>\",\n \"blocks\": [\n {\n \"kind\": \"text\",\n \"id\": \"<string>\",\n \"body\": \"<string>\",\n \"title\": \"<string>\"\n }\n ],\n \"targeting\": {\n \"listingIds\": [\n \"<string>\"\n ],\n \"listingGroupIds\": [\n \"<string>\"\n ]\n },\n \"show_after_check_in_only\": true\n}"
response = http.request(request)
puts response.read_body{
"data": {
"id": "<string>",
"workspace_id": "<string>",
"title": "<string>",
"blocks": [
{
"kind": "text",
"id": "<string>",
"body": "<string>",
"title": "<string>"
}
],
"created_at": 123,
"updated_at": 123,
"description": "<string>",
"category": "<string>",
"cover_image_url": "<string>",
"cover_image_attribution": {
"source": "unsplash",
"photographerName": "<string>",
"photographerUrl": "<string>",
"photoUrl": "<string>"
},
"targeting": {
"listingIds": [
"<string>"
],
"listingGroupIds": [
"<string>"
]
},
"show_after_check_in_only": true,
"order": 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"
}Guides
Create Portal Guide
Create a portal guide for a workspace.
POST
/
v1
/
workspaces
/
{workspace_id}
/
portal-guides
Create Portal Guide
curl --request POST \
--url https://api.conduit.ai/v1/workspaces/{workspace_id}/portal-guides \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"title": "<string>",
"description": "<string>",
"category": "<string>",
"cover_image_url": "<string>",
"blocks": [
{
"kind": "text",
"id": "<string>",
"body": "<string>",
"title": "<string>"
}
],
"targeting": {
"listingIds": [
"<string>"
],
"listingGroupIds": [
"<string>"
]
},
"show_after_check_in_only": true
}
'import requests
url = "https://api.conduit.ai/v1/workspaces/{workspace_id}/portal-guides"
payload = {
"title": "<string>",
"description": "<string>",
"category": "<string>",
"cover_image_url": "<string>",
"blocks": [
{
"kind": "text",
"id": "<string>",
"body": "<string>",
"title": "<string>"
}
],
"targeting": {
"listingIds": ["<string>"],
"listingGroupIds": ["<string>"]
},
"show_after_check_in_only": 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({
title: '<string>',
description: '<string>',
category: '<string>',
cover_image_url: '<string>',
blocks: [
{
kind: 'text',
id: '<string>',
body: JSON.stringify('<string>'),
title: '<string>'
}
],
targeting: {listingIds: ['<string>'], listingGroupIds: ['<string>']},
show_after_check_in_only: true
})
};
fetch('https://api.conduit.ai/v1/workspaces/{workspace_id}/portal-guides', 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-guides",
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([
'title' => '<string>',
'description' => '<string>',
'category' => '<string>',
'cover_image_url' => '<string>',
'blocks' => [
[
'kind' => 'text',
'id' => '<string>',
'body' => '<string>',
'title' => '<string>'
]
],
'targeting' => [
'listingIds' => [
'<string>'
],
'listingGroupIds' => [
'<string>'
]
],
'show_after_check_in_only' => 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}/portal-guides"
payload := strings.NewReader("{\n \"title\": \"<string>\",\n \"description\": \"<string>\",\n \"category\": \"<string>\",\n \"cover_image_url\": \"<string>\",\n \"blocks\": [\n {\n \"kind\": \"text\",\n \"id\": \"<string>\",\n \"body\": \"<string>\",\n \"title\": \"<string>\"\n }\n ],\n \"targeting\": {\n \"listingIds\": [\n \"<string>\"\n ],\n \"listingGroupIds\": [\n \"<string>\"\n ]\n },\n \"show_after_check_in_only\": 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}/portal-guides")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"title\": \"<string>\",\n \"description\": \"<string>\",\n \"category\": \"<string>\",\n \"cover_image_url\": \"<string>\",\n \"blocks\": [\n {\n \"kind\": \"text\",\n \"id\": \"<string>\",\n \"body\": \"<string>\",\n \"title\": \"<string>\"\n }\n ],\n \"targeting\": {\n \"listingIds\": [\n \"<string>\"\n ],\n \"listingGroupIds\": [\n \"<string>\"\n ]\n },\n \"show_after_check_in_only\": true\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.conduit.ai/v1/workspaces/{workspace_id}/portal-guides")
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 \"title\": \"<string>\",\n \"description\": \"<string>\",\n \"category\": \"<string>\",\n \"cover_image_url\": \"<string>\",\n \"blocks\": [\n {\n \"kind\": \"text\",\n \"id\": \"<string>\",\n \"body\": \"<string>\",\n \"title\": \"<string>\"\n }\n ],\n \"targeting\": {\n \"listingIds\": [\n \"<string>\"\n ],\n \"listingGroupIds\": [\n \"<string>\"\n ]\n },\n \"show_after_check_in_only\": true\n}"
response = http.request(request)
puts response.read_body{
"data": {
"id": "<string>",
"workspace_id": "<string>",
"title": "<string>",
"blocks": [
{
"kind": "text",
"id": "<string>",
"body": "<string>",
"title": "<string>"
}
],
"created_at": 123,
"updated_at": 123,
"description": "<string>",
"category": "<string>",
"cover_image_url": "<string>",
"cover_image_attribution": {
"source": "unsplash",
"photographerName": "<string>",
"photographerUrl": "<string>",
"photoUrl": "<string>"
},
"targeting": {
"listingIds": [
"<string>"
],
"listingGroupIds": [
"<string>"
]
},
"show_after_check_in_only": true,
"order": 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
Minimum string length:
1Show child attributes
Show child attributes
- Option 1
- Option 2
- Option 3
- Option 4
- Option 5
- Option 6
- Option 7
- Option 8
- Option 9
- Option 10
- Option 11
- Option 12
- Option 13
Show child attributes
Show child attributes
Available options:
draft, published Show child attributes
Show child attributes
Response
Create Portal Guide
Show child attributes
Show child attributes
Was this page helpful?
⌘I