Add a block to a room
curl --request POST \
--url https://api.journeybee.io/v1/rooms/{uuid}/blocks \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"series": 123,
"label": "<string>",
"content": {},
"block_settings": {
"display": {
"height": 123,
"fullScreen": true,
"showExternalLink": true,
"directEmbed": true
},
"goals": {
"showProgress": true,
"showCountdown": true,
"allowResourceLinks": true
},
"advanced_search": {
"title": "<string>",
"placeholder": "<string>",
"showAITab": true,
"showQuickActions": true
},
"pricing_calculator": {
"allowCreateLead": true,
"enable_lead_submission": true,
"customCustomerName": "<string>"
},
"banner": {},
"secure_files": {
"description": "<string>",
"allow_zip": true
}
},
"asset_uuid": "<string>",
"markdown": "<string>",
"contact_tag_uuids": [
"<string>"
]
}
'import requests
url = "https://api.journeybee.io/v1/rooms/{uuid}/blocks"
payload = {
"series": 123,
"label": "<string>",
"content": {},
"block_settings": {
"display": {
"height": 123,
"fullScreen": True,
"showExternalLink": True,
"directEmbed": True
},
"goals": {
"showProgress": True,
"showCountdown": True,
"allowResourceLinks": True
},
"advanced_search": {
"title": "<string>",
"placeholder": "<string>",
"showAITab": True,
"showQuickActions": True
},
"pricing_calculator": {
"allowCreateLead": True,
"enable_lead_submission": True,
"customCustomerName": "<string>"
},
"banner": {},
"secure_files": {
"description": "<string>",
"allow_zip": True
}
},
"asset_uuid": "<string>",
"markdown": "<string>",
"contact_tag_uuids": ["<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({
series: 123,
label: '<string>',
content: {},
block_settings: {
display: {height: 123, fullScreen: true, showExternalLink: true, directEmbed: true},
goals: {showProgress: true, showCountdown: true, allowResourceLinks: true},
advanced_search: {
title: '<string>',
placeholder: '<string>',
showAITab: true,
showQuickActions: true
},
pricing_calculator: {
allowCreateLead: true,
enable_lead_submission: true,
customCustomerName: '<string>'
},
banner: {},
secure_files: {description: '<string>', allow_zip: true}
},
asset_uuid: '<string>',
markdown: '<string>',
contact_tag_uuids: ['<string>']
})
};
fetch('https://api.journeybee.io/v1/rooms/{uuid}/blocks', 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.journeybee.io/v1/rooms/{uuid}/blocks",
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([
'series' => 123,
'label' => '<string>',
'content' => [
],
'block_settings' => [
'display' => [
'height' => 123,
'fullScreen' => true,
'showExternalLink' => true,
'directEmbed' => true
],
'goals' => [
'showProgress' => true,
'showCountdown' => true,
'allowResourceLinks' => true
],
'advanced_search' => [
'title' => '<string>',
'placeholder' => '<string>',
'showAITab' => true,
'showQuickActions' => true
],
'pricing_calculator' => [
'allowCreateLead' => true,
'enable_lead_submission' => true,
'customCustomerName' => '<string>'
],
'banner' => [
],
'secure_files' => [
'description' => '<string>',
'allow_zip' => true
]
],
'asset_uuid' => '<string>',
'markdown' => '<string>',
'contact_tag_uuids' => [
'<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.journeybee.io/v1/rooms/{uuid}/blocks"
payload := strings.NewReader("{\n \"series\": 123,\n \"label\": \"<string>\",\n \"content\": {},\n \"block_settings\": {\n \"display\": {\n \"height\": 123,\n \"fullScreen\": true,\n \"showExternalLink\": true,\n \"directEmbed\": true\n },\n \"goals\": {\n \"showProgress\": true,\n \"showCountdown\": true,\n \"allowResourceLinks\": true\n },\n \"advanced_search\": {\n \"title\": \"<string>\",\n \"placeholder\": \"<string>\",\n \"showAITab\": true,\n \"showQuickActions\": true\n },\n \"pricing_calculator\": {\n \"allowCreateLead\": true,\n \"enable_lead_submission\": true,\n \"customCustomerName\": \"<string>\"\n },\n \"banner\": {},\n \"secure_files\": {\n \"description\": \"<string>\",\n \"allow_zip\": true\n }\n },\n \"asset_uuid\": \"<string>\",\n \"markdown\": \"<string>\",\n \"contact_tag_uuids\": [\n \"<string>\"\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.journeybee.io/v1/rooms/{uuid}/blocks")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"series\": 123,\n \"label\": \"<string>\",\n \"content\": {},\n \"block_settings\": {\n \"display\": {\n \"height\": 123,\n \"fullScreen\": true,\n \"showExternalLink\": true,\n \"directEmbed\": true\n },\n \"goals\": {\n \"showProgress\": true,\n \"showCountdown\": true,\n \"allowResourceLinks\": true\n },\n \"advanced_search\": {\n \"title\": \"<string>\",\n \"placeholder\": \"<string>\",\n \"showAITab\": true,\n \"showQuickActions\": true\n },\n \"pricing_calculator\": {\n \"allowCreateLead\": true,\n \"enable_lead_submission\": true,\n \"customCustomerName\": \"<string>\"\n },\n \"banner\": {},\n \"secure_files\": {\n \"description\": \"<string>\",\n \"allow_zip\": true\n }\n },\n \"asset_uuid\": \"<string>\",\n \"markdown\": \"<string>\",\n \"contact_tag_uuids\": [\n \"<string>\"\n ]\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.journeybee.io/v1/rooms/{uuid}/blocks")
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 \"series\": 123,\n \"label\": \"<string>\",\n \"content\": {},\n \"block_settings\": {\n \"display\": {\n \"height\": 123,\n \"fullScreen\": true,\n \"showExternalLink\": true,\n \"directEmbed\": true\n },\n \"goals\": {\n \"showProgress\": true,\n \"showCountdown\": true,\n \"allowResourceLinks\": true\n },\n \"advanced_search\": {\n \"title\": \"<string>\",\n \"placeholder\": \"<string>\",\n \"showAITab\": true,\n \"showQuickActions\": true\n },\n \"pricing_calculator\": {\n \"allowCreateLead\": true,\n \"enable_lead_submission\": true,\n \"customCustomerName\": \"<string>\"\n },\n \"banner\": {},\n \"secure_files\": {\n \"description\": \"<string>\",\n \"allow_zip\": true\n }\n },\n \"asset_uuid\": \"<string>\",\n \"markdown\": \"<string>\",\n \"contact_tag_uuids\": [\n \"<string>\"\n ]\n}"
response = http.request(request)
puts response.read_body{
"uuid": "<string>",
"block_type": "text",
"label": "<string>",
"series": 123,
"content": "<unknown>",
"block_settings": {
"display": {
"height": 123,
"fullScreen": true,
"showExternalLink": true,
"directEmbed": true,
"pdfViewerMode": "paged"
},
"action_bar": {
"buttons": [
{
"label": "<string>",
"event": "send_lead",
"icon": "<string>",
"url": "<string>",
"background_color": "<string>",
"text_color": "<string>",
"icon_color": "<string>",
"room_uuid": "<string>",
"resource_uuid": "<string>",
"folder_uuid": "<string>",
"certification_uuid": "<string>",
"series": 500
}
]
},
"goals": {
"showProgress": true,
"showCountdown": true,
"allowResourceLinks": true
},
"advanced_search": {
"title": "<string>",
"placeholder": "<string>",
"showAITab": true,
"showQuickActions": true
},
"pricing_calculator": {
"allowCreateLead": true,
"enable_lead_submission": true,
"defaultCustomerName": "partner_company_name",
"customCustomerName": "<string>"
},
"banner": {
"displayMode": "company",
"companyLogoPosition": "left"
},
"secure_files": {
"description": "<string>",
"allow_zip": true
}
},
"asset_uuid": "<string>",
"contact_tag_uuids": [
"<string>"
],
"created_at": "<string>",
"updated_at": "<string>"
}Room Blocks
Add a block to a room
POST
/
rooms
/
{uuid}
/
blocks
Add a block to a room
curl --request POST \
--url https://api.journeybee.io/v1/rooms/{uuid}/blocks \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"series": 123,
"label": "<string>",
"content": {},
"block_settings": {
"display": {
"height": 123,
"fullScreen": true,
"showExternalLink": true,
"directEmbed": true
},
"goals": {
"showProgress": true,
"showCountdown": true,
"allowResourceLinks": true
},
"advanced_search": {
"title": "<string>",
"placeholder": "<string>",
"showAITab": true,
"showQuickActions": true
},
"pricing_calculator": {
"allowCreateLead": true,
"enable_lead_submission": true,
"customCustomerName": "<string>"
},
"banner": {},
"secure_files": {
"description": "<string>",
"allow_zip": true
}
},
"asset_uuid": "<string>",
"markdown": "<string>",
"contact_tag_uuids": [
"<string>"
]
}
'import requests
url = "https://api.journeybee.io/v1/rooms/{uuid}/blocks"
payload = {
"series": 123,
"label": "<string>",
"content": {},
"block_settings": {
"display": {
"height": 123,
"fullScreen": True,
"showExternalLink": True,
"directEmbed": True
},
"goals": {
"showProgress": True,
"showCountdown": True,
"allowResourceLinks": True
},
"advanced_search": {
"title": "<string>",
"placeholder": "<string>",
"showAITab": True,
"showQuickActions": True
},
"pricing_calculator": {
"allowCreateLead": True,
"enable_lead_submission": True,
"customCustomerName": "<string>"
},
"banner": {},
"secure_files": {
"description": "<string>",
"allow_zip": True
}
},
"asset_uuid": "<string>",
"markdown": "<string>",
"contact_tag_uuids": ["<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({
series: 123,
label: '<string>',
content: {},
block_settings: {
display: {height: 123, fullScreen: true, showExternalLink: true, directEmbed: true},
goals: {showProgress: true, showCountdown: true, allowResourceLinks: true},
advanced_search: {
title: '<string>',
placeholder: '<string>',
showAITab: true,
showQuickActions: true
},
pricing_calculator: {
allowCreateLead: true,
enable_lead_submission: true,
customCustomerName: '<string>'
},
banner: {},
secure_files: {description: '<string>', allow_zip: true}
},
asset_uuid: '<string>',
markdown: '<string>',
contact_tag_uuids: ['<string>']
})
};
fetch('https://api.journeybee.io/v1/rooms/{uuid}/blocks', 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.journeybee.io/v1/rooms/{uuid}/blocks",
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([
'series' => 123,
'label' => '<string>',
'content' => [
],
'block_settings' => [
'display' => [
'height' => 123,
'fullScreen' => true,
'showExternalLink' => true,
'directEmbed' => true
],
'goals' => [
'showProgress' => true,
'showCountdown' => true,
'allowResourceLinks' => true
],
'advanced_search' => [
'title' => '<string>',
'placeholder' => '<string>',
'showAITab' => true,
'showQuickActions' => true
],
'pricing_calculator' => [
'allowCreateLead' => true,
'enable_lead_submission' => true,
'customCustomerName' => '<string>'
],
'banner' => [
],
'secure_files' => [
'description' => '<string>',
'allow_zip' => true
]
],
'asset_uuid' => '<string>',
'markdown' => '<string>',
'contact_tag_uuids' => [
'<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.journeybee.io/v1/rooms/{uuid}/blocks"
payload := strings.NewReader("{\n \"series\": 123,\n \"label\": \"<string>\",\n \"content\": {},\n \"block_settings\": {\n \"display\": {\n \"height\": 123,\n \"fullScreen\": true,\n \"showExternalLink\": true,\n \"directEmbed\": true\n },\n \"goals\": {\n \"showProgress\": true,\n \"showCountdown\": true,\n \"allowResourceLinks\": true\n },\n \"advanced_search\": {\n \"title\": \"<string>\",\n \"placeholder\": \"<string>\",\n \"showAITab\": true,\n \"showQuickActions\": true\n },\n \"pricing_calculator\": {\n \"allowCreateLead\": true,\n \"enable_lead_submission\": true,\n \"customCustomerName\": \"<string>\"\n },\n \"banner\": {},\n \"secure_files\": {\n \"description\": \"<string>\",\n \"allow_zip\": true\n }\n },\n \"asset_uuid\": \"<string>\",\n \"markdown\": \"<string>\",\n \"contact_tag_uuids\": [\n \"<string>\"\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.journeybee.io/v1/rooms/{uuid}/blocks")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"series\": 123,\n \"label\": \"<string>\",\n \"content\": {},\n \"block_settings\": {\n \"display\": {\n \"height\": 123,\n \"fullScreen\": true,\n \"showExternalLink\": true,\n \"directEmbed\": true\n },\n \"goals\": {\n \"showProgress\": true,\n \"showCountdown\": true,\n \"allowResourceLinks\": true\n },\n \"advanced_search\": {\n \"title\": \"<string>\",\n \"placeholder\": \"<string>\",\n \"showAITab\": true,\n \"showQuickActions\": true\n },\n \"pricing_calculator\": {\n \"allowCreateLead\": true,\n \"enable_lead_submission\": true,\n \"customCustomerName\": \"<string>\"\n },\n \"banner\": {},\n \"secure_files\": {\n \"description\": \"<string>\",\n \"allow_zip\": true\n }\n },\n \"asset_uuid\": \"<string>\",\n \"markdown\": \"<string>\",\n \"contact_tag_uuids\": [\n \"<string>\"\n ]\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.journeybee.io/v1/rooms/{uuid}/blocks")
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 \"series\": 123,\n \"label\": \"<string>\",\n \"content\": {},\n \"block_settings\": {\n \"display\": {\n \"height\": 123,\n \"fullScreen\": true,\n \"showExternalLink\": true,\n \"directEmbed\": true\n },\n \"goals\": {\n \"showProgress\": true,\n \"showCountdown\": true,\n \"allowResourceLinks\": true\n },\n \"advanced_search\": {\n \"title\": \"<string>\",\n \"placeholder\": \"<string>\",\n \"showAITab\": true,\n \"showQuickActions\": true\n },\n \"pricing_calculator\": {\n \"allowCreateLead\": true,\n \"enable_lead_submission\": true,\n \"customCustomerName\": \"<string>\"\n },\n \"banner\": {},\n \"secure_files\": {\n \"description\": \"<string>\",\n \"allow_zip\": true\n }\n },\n \"asset_uuid\": \"<string>\",\n \"markdown\": \"<string>\",\n \"contact_tag_uuids\": [\n \"<string>\"\n ]\n}"
response = http.request(request)
puts response.read_body{
"uuid": "<string>",
"block_type": "text",
"label": "<string>",
"series": 123,
"content": "<unknown>",
"block_settings": {
"display": {
"height": 123,
"fullScreen": true,
"showExternalLink": true,
"directEmbed": true,
"pdfViewerMode": "paged"
},
"action_bar": {
"buttons": [
{
"label": "<string>",
"event": "send_lead",
"icon": "<string>",
"url": "<string>",
"background_color": "<string>",
"text_color": "<string>",
"icon_color": "<string>",
"room_uuid": "<string>",
"resource_uuid": "<string>",
"folder_uuid": "<string>",
"certification_uuid": "<string>",
"series": 500
}
]
},
"goals": {
"showProgress": true,
"showCountdown": true,
"allowResourceLinks": true
},
"advanced_search": {
"title": "<string>",
"placeholder": "<string>",
"showAITab": true,
"showQuickActions": true
},
"pricing_calculator": {
"allowCreateLead": true,
"enable_lead_submission": true,
"defaultCustomerName": "partner_company_name",
"customCustomerName": "<string>"
},
"banner": {
"displayMode": "company",
"companyLogoPosition": "left"
},
"secure_files": {
"description": "<string>",
"allow_zip": true
}
},
"asset_uuid": "<string>",
"contact_tag_uuids": [
"<string>"
],
"created_at": "<string>",
"updated_at": "<string>"
}Authorizations
API key authentication. Use "Bearer <api_key>" or "Api-Key <api_key>".
Path Parameters
Pattern:
^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$Body
application/json
Create a content block. Rooms are composed of ordered blocks — each block is a distinct content unit (text, image, video, goals, action bar, etc.).
Create a content block. Rooms are composed of ordered blocks — each block is a distinct content unit (text, image, video, goals, action bar, etc.).
Block type. Determines how content is interpreted: text (TipTap JSON), image (use asset_uuid), video (use asset_uuid), document (use asset_uuid), embed (use content with url), introduction (TipTap JSON), action_bar (use block_settings.action_bar), banner (use block_settings.banner), lead_deal_analytics (no content), goals (content with goals array), link (content with links), advanced_search (use block_settings.advanced_search), files (content with files array), pricing_calculator (use block_settings.pricing_calculator), secure_files (no content; use block_settings.secure_files — the files themselves are managed through the room secure-files endpoints).
Available options:
text, image, video, document, embed, introduction, action_bar, banner, lead_deal_analytics, goals, link, advanced_search, files, pricing_calculator, partner_details, secure_files Display order (1-indexed). Blocks are rendered in ascending series order.
Block content. Shape depends on block_type: text/introduction -> TipTap JSON; goals -> {title, description, goals: [...], startDate?, targetDate?}, where each date is a 'YYYY-MM-DD' string, {mode: 'fixed', date: 'YYYY-MM-DD'} or {mode: 'relative', anchor: 'partnership_created' | 'room_exposed' | 'partner_enabled', offsetDays} (resolved per partnership; negative offsets are before the anchor), and targetDate may also be {mode: 'after_start', days}; link -> link collection; files -> {files: [...]}; embed -> {url}; image/video/document -> null (use asset_uuid); action_bar/banner/advanced_search/pricing_calculator/lead_deal_analytics/secure_files -> null (use block_settings).
Show child attributes
Show child attributes
Block-type-specific settings. See apiRoomBlockSettingsSchema for details.
Show child attributes
Show child attributes
Asset UUID for image, video, or document blocks.
Markdown content for text blocks. When provided, converts to TipTap JSON and overrides the content field.
Maximum string length:
100000Contact tags allowed to see this block. With none, every contact who can see the room sees the block. With one or more, only contacts that carry at least one of these tags see it. Omit, or send [], to create a block every room viewer sees. Tag UUIDs must be this company's contact tags (association "contact"; find them with listTags and association=contact). An unknown UUID, a tag from another company or a tag with any other association rejects the whole request. At most 100.
Maximum array length:
100Response
201 - application/json
Default Response
Available options:
text, image, video, document, embed, introduction, action_bar, banner, lead_deal_analytics, goals, link, advanced_search, files, pricing_calculator, partner_details, form, secure_files Display order (1-indexed)
Block content — shape varies by block_type. See documentation.
Block-type-specific settings, as returned by the API. Same shape as the request except action_bar button target uuids (resource_uuid/folder_uuid/certification_uuid/room_uuid) tolerate null when the stored target no longer resolves for the caller's company.
Show child attributes
Show child attributes
Associated asset (image, video file, document, etc.)
Contact tags allowed to see this block. With none, every contact who can see the room sees the block. With one or more, only contacts that carry at least one of these tags see it. An empty list means the block has no tag restriction.