Create page
curl --request POST \
--url https://api.tryarchitect.com/v0/pages \
--header 'Content-Type: application/json' \
--header 'x-api-key: <api-key>' \
--data '
{
"actions": [
{
"purpose": "<string>",
"buttonTitle": "<string>",
"actionType": "<string>",
"url": "<string>",
"actionId": "<string>"
}
],
"actionCardWidgets": [],
"brandId": "<string>",
"footerLinks": [
{
"links": [
{
"text": "<string>",
"url": "<string>",
"id": "<string>"
}
],
"title": "<string>",
"id": "<string>"
}
],
"name": "<string>",
"navLinks": [],
"pageContext": "<string>",
"pageType": "inbound",
"scripts": [],
"footerLinkBlockId": "<string>",
"headerActionId": "<string>",
"metadata": {
"title": "<string>",
"description": "<string>",
"keywords": [
"<string>"
],
"author": "<string>",
"robots": [],
"canonicalUrl": "<string>",
"ogTitle": "<string>",
"ogDescription": "<string>",
"ogImageAlt": "<string>",
"ogSiteName": "<string>",
"ogUrl": "<string>",
"twitterTitle": "<string>",
"twitterDescription": "<string>",
"twitterImageAlt": "<string>",
"twitterSite": "<string>",
"twitterCreator": "<string>",
"themeColor": "<string>"
},
"navLinkBlockId": "<string>"
}
'import requests
url = "https://api.tryarchitect.com/v0/pages"
payload = {
"actions": [
{
"purpose": "<string>",
"buttonTitle": "<string>",
"actionType": "<string>",
"url": "<string>",
"actionId": "<string>"
}
],
"actionCardWidgets": [],
"brandId": "<string>",
"footerLinks": [
{
"links": [
{
"text": "<string>",
"url": "<string>",
"id": "<string>"
}
],
"title": "<string>",
"id": "<string>"
}
],
"name": "<string>",
"navLinks": [],
"pageContext": "<string>",
"pageType": "inbound",
"scripts": [],
"footerLinkBlockId": "<string>",
"headerActionId": "<string>",
"metadata": {
"title": "<string>",
"description": "<string>",
"keywords": ["<string>"],
"author": "<string>",
"robots": [],
"canonicalUrl": "<string>",
"ogTitle": "<string>",
"ogDescription": "<string>",
"ogImageAlt": "<string>",
"ogSiteName": "<string>",
"ogUrl": "<string>",
"twitterTitle": "<string>",
"twitterDescription": "<string>",
"twitterImageAlt": "<string>",
"twitterSite": "<string>",
"twitterCreator": "<string>",
"themeColor": "<string>"
},
"navLinkBlockId": "<string>"
}
headers = {
"x-api-key": "<api-key>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {'x-api-key': '<api-key>', 'Content-Type': 'application/json'},
body: JSON.stringify({
actions: [
{
purpose: '<string>',
buttonTitle: '<string>',
actionType: '<string>',
url: '<string>',
actionId: '<string>'
}
],
actionCardWidgets: [],
brandId: '<string>',
footerLinks: [
{
links: [{text: '<string>', url: '<string>', id: '<string>'}],
title: '<string>',
id: '<string>'
}
],
name: '<string>',
navLinks: [],
pageContext: '<string>',
pageType: 'inbound',
scripts: [],
footerLinkBlockId: '<string>',
headerActionId: '<string>',
metadata: {
title: '<string>',
description: '<string>',
keywords: ['<string>'],
author: '<string>',
robots: [],
canonicalUrl: '<string>',
ogTitle: '<string>',
ogDescription: '<string>',
ogImageAlt: '<string>',
ogSiteName: '<string>',
ogUrl: '<string>',
twitterTitle: '<string>',
twitterDescription: '<string>',
twitterImageAlt: '<string>',
twitterSite: '<string>',
twitterCreator: '<string>',
themeColor: '<string>'
},
navLinkBlockId: '<string>'
})
};
fetch('https://api.tryarchitect.com/v0/pages', 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.tryarchitect.com/v0/pages",
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([
'actions' => [
[
'purpose' => '<string>',
'buttonTitle' => '<string>',
'actionType' => '<string>',
'url' => '<string>',
'actionId' => '<string>'
]
],
'actionCardWidgets' => [
],
'brandId' => '<string>',
'footerLinks' => [
[
'links' => [
[
'text' => '<string>',
'url' => '<string>',
'id' => '<string>'
]
],
'title' => '<string>',
'id' => '<string>'
]
],
'name' => '<string>',
'navLinks' => [
],
'pageContext' => '<string>',
'pageType' => 'inbound',
'scripts' => [
],
'footerLinkBlockId' => '<string>',
'headerActionId' => '<string>',
'metadata' => [
'title' => '<string>',
'description' => '<string>',
'keywords' => [
'<string>'
],
'author' => '<string>',
'robots' => [
],
'canonicalUrl' => '<string>',
'ogTitle' => '<string>',
'ogDescription' => '<string>',
'ogImageAlt' => '<string>',
'ogSiteName' => '<string>',
'ogUrl' => '<string>',
'twitterTitle' => '<string>',
'twitterDescription' => '<string>',
'twitterImageAlt' => '<string>',
'twitterSite' => '<string>',
'twitterCreator' => '<string>',
'themeColor' => '<string>'
],
'navLinkBlockId' => '<string>'
]),
CURLOPT_HTTPHEADER => [
"Content-Type: application/json",
"x-api-key: <api-key>"
],
]);
$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.tryarchitect.com/v0/pages"
payload := strings.NewReader("{\n \"actions\": [\n {\n \"purpose\": \"<string>\",\n \"buttonTitle\": \"<string>\",\n \"actionType\": \"<string>\",\n \"url\": \"<string>\",\n \"actionId\": \"<string>\"\n }\n ],\n \"actionCardWidgets\": [],\n \"brandId\": \"<string>\",\n \"footerLinks\": [\n {\n \"links\": [\n {\n \"text\": \"<string>\",\n \"url\": \"<string>\",\n \"id\": \"<string>\"\n }\n ],\n \"title\": \"<string>\",\n \"id\": \"<string>\"\n }\n ],\n \"name\": \"<string>\",\n \"navLinks\": [],\n \"pageContext\": \"<string>\",\n \"pageType\": \"inbound\",\n \"scripts\": [],\n \"footerLinkBlockId\": \"<string>\",\n \"headerActionId\": \"<string>\",\n \"metadata\": {\n \"title\": \"<string>\",\n \"description\": \"<string>\",\n \"keywords\": [\n \"<string>\"\n ],\n \"author\": \"<string>\",\n \"robots\": [],\n \"canonicalUrl\": \"<string>\",\n \"ogTitle\": \"<string>\",\n \"ogDescription\": \"<string>\",\n \"ogImageAlt\": \"<string>\",\n \"ogSiteName\": \"<string>\",\n \"ogUrl\": \"<string>\",\n \"twitterTitle\": \"<string>\",\n \"twitterDescription\": \"<string>\",\n \"twitterImageAlt\": \"<string>\",\n \"twitterSite\": \"<string>\",\n \"twitterCreator\": \"<string>\",\n \"themeColor\": \"<string>\"\n },\n \"navLinkBlockId\": \"<string>\"\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("x-api-key", "<api-key>")
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.tryarchitect.com/v0/pages")
.header("x-api-key", "<api-key>")
.header("Content-Type", "application/json")
.body("{\n \"actions\": [\n {\n \"purpose\": \"<string>\",\n \"buttonTitle\": \"<string>\",\n \"actionType\": \"<string>\",\n \"url\": \"<string>\",\n \"actionId\": \"<string>\"\n }\n ],\n \"actionCardWidgets\": [],\n \"brandId\": \"<string>\",\n \"footerLinks\": [\n {\n \"links\": [\n {\n \"text\": \"<string>\",\n \"url\": \"<string>\",\n \"id\": \"<string>\"\n }\n ],\n \"title\": \"<string>\",\n \"id\": \"<string>\"\n }\n ],\n \"name\": \"<string>\",\n \"navLinks\": [],\n \"pageContext\": \"<string>\",\n \"pageType\": \"inbound\",\n \"scripts\": [],\n \"footerLinkBlockId\": \"<string>\",\n \"headerActionId\": \"<string>\",\n \"metadata\": {\n \"title\": \"<string>\",\n \"description\": \"<string>\",\n \"keywords\": [\n \"<string>\"\n ],\n \"author\": \"<string>\",\n \"robots\": [],\n \"canonicalUrl\": \"<string>\",\n \"ogTitle\": \"<string>\",\n \"ogDescription\": \"<string>\",\n \"ogImageAlt\": \"<string>\",\n \"ogSiteName\": \"<string>\",\n \"ogUrl\": \"<string>\",\n \"twitterTitle\": \"<string>\",\n \"twitterDescription\": \"<string>\",\n \"twitterImageAlt\": \"<string>\",\n \"twitterSite\": \"<string>\",\n \"twitterCreator\": \"<string>\",\n \"themeColor\": \"<string>\"\n },\n \"navLinkBlockId\": \"<string>\"\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.tryarchitect.com/v0/pages")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["x-api-key"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"actions\": [\n {\n \"purpose\": \"<string>\",\n \"buttonTitle\": \"<string>\",\n \"actionType\": \"<string>\",\n \"url\": \"<string>\",\n \"actionId\": \"<string>\"\n }\n ],\n \"actionCardWidgets\": [],\n \"brandId\": \"<string>\",\n \"footerLinks\": [\n {\n \"links\": [\n {\n \"text\": \"<string>\",\n \"url\": \"<string>\",\n \"id\": \"<string>\"\n }\n ],\n \"title\": \"<string>\",\n \"id\": \"<string>\"\n }\n ],\n \"name\": \"<string>\",\n \"navLinks\": [],\n \"pageContext\": \"<string>\",\n \"pageType\": \"inbound\",\n \"scripts\": [],\n \"footerLinkBlockId\": \"<string>\",\n \"headerActionId\": \"<string>\",\n \"metadata\": {\n \"title\": \"<string>\",\n \"description\": \"<string>\",\n \"keywords\": [\n \"<string>\"\n ],\n \"author\": \"<string>\",\n \"robots\": [],\n \"canonicalUrl\": \"<string>\",\n \"ogTitle\": \"<string>\",\n \"ogDescription\": \"<string>\",\n \"ogImageAlt\": \"<string>\",\n \"ogSiteName\": \"<string>\",\n \"ogUrl\": \"<string>\",\n \"twitterTitle\": \"<string>\",\n \"twitterDescription\": \"<string>\",\n \"twitterImageAlt\": \"<string>\",\n \"twitterSite\": \"<string>\",\n \"twitterCreator\": \"<string>\",\n \"themeColor\": \"<string>\"\n },\n \"navLinkBlockId\": \"<string>\"\n}"
response = http.request(request)
puts response.read_body{
"actions": [
{
"actionId": "<string>",
"actionIndex": 123,
"purpose": "<string>",
"buttonTitle": "<string>",
"actionType": "<string>",
"url": "<string>"
}
],
"actionCardWidgets": [
{
"type": "<string>",
"title": "<string>",
"logos": [
{
"image": {
"altText": "<string>",
"url": "<string>",
"fileId": "2023-11-07T05:31:56Z",
"assetId": "2023-11-07T05:31:56Z"
}
}
]
}
],
"archivedAt": "2023-11-07T05:31:56Z",
"audiencesCount": 4503599627370495,
"brandId": "<string>",
"createdAt": "2023-11-07T05:31:56Z",
"deletedAt": "2023-11-07T05:31:56Z",
"footerLinkBlockId": "<string>",
"footerLinks": [
{
"links": [
{
"text": "<string>",
"url": "<string>",
"id": "<string>"
}
],
"title": "<string>",
"id": "<string>"
}
],
"flags": [
"home_page"
],
"name": "<string>",
"navLinkBlockId": "<string>",
"navLinks": [
{
"type": "<string>",
"text": "<string>",
"url": "<string>",
"id": "<string>"
}
],
"pageContext": "<string>",
"pageId": "<string>",
"scripts": [
{
"content": "<string>",
"enabled": true,
"name": "<string>",
"description": "<string>"
}
],
"title": "<string>",
"updatedAt": "2023-11-07T05:31:56Z",
"headerActionId": "<string>",
"metadata": {
"title": "<string>",
"description": "<string>",
"keywords": [
"<string>"
],
"author": "<string>",
"robots": [],
"canonicalUrl": "<string>",
"ogTitle": "<string>",
"ogDescription": "<string>",
"ogImageUrl": "<string>",
"ogImageFileId": "<string>",
"ogImageAlt": "<string>",
"ogSiteName": "<string>",
"ogUrl": "<string>",
"twitterTitle": "<string>",
"twitterDescription": "<string>",
"twitterImageUrl": "<string>",
"twitterImageFileId": "<string>",
"twitterImageAlt": "<string>",
"twitterSite": "<string>",
"twitterCreator": "<string>",
"themeColor": "<string>"
}
}{
"code": "VALIDATION_ERROR",
"detail": "body - name: Name is required; email: Invalid email address",
"details": [
{
"field": "body",
"issues": [
{
"code": "validation_failed",
"message": "name: Name is required",
"path": [
"name"
]
}
]
}
],
"requestId": "req_01j5k9m7n8p9q2r3s4t5v6w7x8",
"status": 400,
"title": "Bad Request",
"type": "https://api.tryarchitect.com/errors/validation_error"
}{
"code": "UNAUTHORIZED",
"detail": "Authentication is required",
"requestId": "req_01j5k9m7n8p9q2r3s4t5v6w7x8",
"status": 401,
"title": "Unauthorized",
"type": "https://api.tryarchitect.com/errors/unauthorized"
}{
"code": "FORBIDDEN",
"detail": "Multi-tenant API keys are not supported",
"requestId": "req_01j5k9m7n8p9q2r3s4t5v6w7x8",
"status": 403,
"title": "Forbidden",
"type": "https://api.tryarchitect.com/errors/forbidden"
}{
"code": "CONFLICT",
"detail": "Default topic titles cannot be updated",
"requestId": "req_01j5k9m7n8p9q2r3s4t5v6w7x8",
"status": 409,
"title": "Conflict",
"type": "https://api.tryarchitect.com/errors/conflict"
}{
"code": "RATE_LIMITED",
"detail": "Rate limit exceeded",
"details": {
"limit": 100,
"remaining": 0,
"resetTime": 1713225600000,
"retryAfter": 60
},
"requestId": "req_01j5k9m7n8p9q2r3s4t5v6w7x8",
"status": 429,
"title": "Too Many Requests",
"type": "https://api.tryarchitect.com/errors/rate_limited"
}{
"code": "INTERNAL",
"detail": "An unexpected error occurred",
"requestId": "req_01j5k9m7n8p9q2r3s4t5v6w7x8",
"status": 500,
"title": "Internal Server Error",
"type": "https://api.tryarchitect.com/errors/internal"
}{
"code": "SERVICE_UNAVAILABLE",
"detail": "The service is temporarily unavailable",
"requestId": "req_01j5k9m7n8p9q2r3s4t5v6w7x8",
"status": 503,
"title": "Service Unavailable",
"type": "https://api.tryarchitect.com/errors/service_unavailable"
}Pages
Create page
Create a page.
POST
/
v0
/
pages
Create page
curl --request POST \
--url https://api.tryarchitect.com/v0/pages \
--header 'Content-Type: application/json' \
--header 'x-api-key: <api-key>' \
--data '
{
"actions": [
{
"purpose": "<string>",
"buttonTitle": "<string>",
"actionType": "<string>",
"url": "<string>",
"actionId": "<string>"
}
],
"actionCardWidgets": [],
"brandId": "<string>",
"footerLinks": [
{
"links": [
{
"text": "<string>",
"url": "<string>",
"id": "<string>"
}
],
"title": "<string>",
"id": "<string>"
}
],
"name": "<string>",
"navLinks": [],
"pageContext": "<string>",
"pageType": "inbound",
"scripts": [],
"footerLinkBlockId": "<string>",
"headerActionId": "<string>",
"metadata": {
"title": "<string>",
"description": "<string>",
"keywords": [
"<string>"
],
"author": "<string>",
"robots": [],
"canonicalUrl": "<string>",
"ogTitle": "<string>",
"ogDescription": "<string>",
"ogImageAlt": "<string>",
"ogSiteName": "<string>",
"ogUrl": "<string>",
"twitterTitle": "<string>",
"twitterDescription": "<string>",
"twitterImageAlt": "<string>",
"twitterSite": "<string>",
"twitterCreator": "<string>",
"themeColor": "<string>"
},
"navLinkBlockId": "<string>"
}
'import requests
url = "https://api.tryarchitect.com/v0/pages"
payload = {
"actions": [
{
"purpose": "<string>",
"buttonTitle": "<string>",
"actionType": "<string>",
"url": "<string>",
"actionId": "<string>"
}
],
"actionCardWidgets": [],
"brandId": "<string>",
"footerLinks": [
{
"links": [
{
"text": "<string>",
"url": "<string>",
"id": "<string>"
}
],
"title": "<string>",
"id": "<string>"
}
],
"name": "<string>",
"navLinks": [],
"pageContext": "<string>",
"pageType": "inbound",
"scripts": [],
"footerLinkBlockId": "<string>",
"headerActionId": "<string>",
"metadata": {
"title": "<string>",
"description": "<string>",
"keywords": ["<string>"],
"author": "<string>",
"robots": [],
"canonicalUrl": "<string>",
"ogTitle": "<string>",
"ogDescription": "<string>",
"ogImageAlt": "<string>",
"ogSiteName": "<string>",
"ogUrl": "<string>",
"twitterTitle": "<string>",
"twitterDescription": "<string>",
"twitterImageAlt": "<string>",
"twitterSite": "<string>",
"twitterCreator": "<string>",
"themeColor": "<string>"
},
"navLinkBlockId": "<string>"
}
headers = {
"x-api-key": "<api-key>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {'x-api-key': '<api-key>', 'Content-Type': 'application/json'},
body: JSON.stringify({
actions: [
{
purpose: '<string>',
buttonTitle: '<string>',
actionType: '<string>',
url: '<string>',
actionId: '<string>'
}
],
actionCardWidgets: [],
brandId: '<string>',
footerLinks: [
{
links: [{text: '<string>', url: '<string>', id: '<string>'}],
title: '<string>',
id: '<string>'
}
],
name: '<string>',
navLinks: [],
pageContext: '<string>',
pageType: 'inbound',
scripts: [],
footerLinkBlockId: '<string>',
headerActionId: '<string>',
metadata: {
title: '<string>',
description: '<string>',
keywords: ['<string>'],
author: '<string>',
robots: [],
canonicalUrl: '<string>',
ogTitle: '<string>',
ogDescription: '<string>',
ogImageAlt: '<string>',
ogSiteName: '<string>',
ogUrl: '<string>',
twitterTitle: '<string>',
twitterDescription: '<string>',
twitterImageAlt: '<string>',
twitterSite: '<string>',
twitterCreator: '<string>',
themeColor: '<string>'
},
navLinkBlockId: '<string>'
})
};
fetch('https://api.tryarchitect.com/v0/pages', 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.tryarchitect.com/v0/pages",
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([
'actions' => [
[
'purpose' => '<string>',
'buttonTitle' => '<string>',
'actionType' => '<string>',
'url' => '<string>',
'actionId' => '<string>'
]
],
'actionCardWidgets' => [
],
'brandId' => '<string>',
'footerLinks' => [
[
'links' => [
[
'text' => '<string>',
'url' => '<string>',
'id' => '<string>'
]
],
'title' => '<string>',
'id' => '<string>'
]
],
'name' => '<string>',
'navLinks' => [
],
'pageContext' => '<string>',
'pageType' => 'inbound',
'scripts' => [
],
'footerLinkBlockId' => '<string>',
'headerActionId' => '<string>',
'metadata' => [
'title' => '<string>',
'description' => '<string>',
'keywords' => [
'<string>'
],
'author' => '<string>',
'robots' => [
],
'canonicalUrl' => '<string>',
'ogTitle' => '<string>',
'ogDescription' => '<string>',
'ogImageAlt' => '<string>',
'ogSiteName' => '<string>',
'ogUrl' => '<string>',
'twitterTitle' => '<string>',
'twitterDescription' => '<string>',
'twitterImageAlt' => '<string>',
'twitterSite' => '<string>',
'twitterCreator' => '<string>',
'themeColor' => '<string>'
],
'navLinkBlockId' => '<string>'
]),
CURLOPT_HTTPHEADER => [
"Content-Type: application/json",
"x-api-key: <api-key>"
],
]);
$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.tryarchitect.com/v0/pages"
payload := strings.NewReader("{\n \"actions\": [\n {\n \"purpose\": \"<string>\",\n \"buttonTitle\": \"<string>\",\n \"actionType\": \"<string>\",\n \"url\": \"<string>\",\n \"actionId\": \"<string>\"\n }\n ],\n \"actionCardWidgets\": [],\n \"brandId\": \"<string>\",\n \"footerLinks\": [\n {\n \"links\": [\n {\n \"text\": \"<string>\",\n \"url\": \"<string>\",\n \"id\": \"<string>\"\n }\n ],\n \"title\": \"<string>\",\n \"id\": \"<string>\"\n }\n ],\n \"name\": \"<string>\",\n \"navLinks\": [],\n \"pageContext\": \"<string>\",\n \"pageType\": \"inbound\",\n \"scripts\": [],\n \"footerLinkBlockId\": \"<string>\",\n \"headerActionId\": \"<string>\",\n \"metadata\": {\n \"title\": \"<string>\",\n \"description\": \"<string>\",\n \"keywords\": [\n \"<string>\"\n ],\n \"author\": \"<string>\",\n \"robots\": [],\n \"canonicalUrl\": \"<string>\",\n \"ogTitle\": \"<string>\",\n \"ogDescription\": \"<string>\",\n \"ogImageAlt\": \"<string>\",\n \"ogSiteName\": \"<string>\",\n \"ogUrl\": \"<string>\",\n \"twitterTitle\": \"<string>\",\n \"twitterDescription\": \"<string>\",\n \"twitterImageAlt\": \"<string>\",\n \"twitterSite\": \"<string>\",\n \"twitterCreator\": \"<string>\",\n \"themeColor\": \"<string>\"\n },\n \"navLinkBlockId\": \"<string>\"\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("x-api-key", "<api-key>")
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.tryarchitect.com/v0/pages")
.header("x-api-key", "<api-key>")
.header("Content-Type", "application/json")
.body("{\n \"actions\": [\n {\n \"purpose\": \"<string>\",\n \"buttonTitle\": \"<string>\",\n \"actionType\": \"<string>\",\n \"url\": \"<string>\",\n \"actionId\": \"<string>\"\n }\n ],\n \"actionCardWidgets\": [],\n \"brandId\": \"<string>\",\n \"footerLinks\": [\n {\n \"links\": [\n {\n \"text\": \"<string>\",\n \"url\": \"<string>\",\n \"id\": \"<string>\"\n }\n ],\n \"title\": \"<string>\",\n \"id\": \"<string>\"\n }\n ],\n \"name\": \"<string>\",\n \"navLinks\": [],\n \"pageContext\": \"<string>\",\n \"pageType\": \"inbound\",\n \"scripts\": [],\n \"footerLinkBlockId\": \"<string>\",\n \"headerActionId\": \"<string>\",\n \"metadata\": {\n \"title\": \"<string>\",\n \"description\": \"<string>\",\n \"keywords\": [\n \"<string>\"\n ],\n \"author\": \"<string>\",\n \"robots\": [],\n \"canonicalUrl\": \"<string>\",\n \"ogTitle\": \"<string>\",\n \"ogDescription\": \"<string>\",\n \"ogImageAlt\": \"<string>\",\n \"ogSiteName\": \"<string>\",\n \"ogUrl\": \"<string>\",\n \"twitterTitle\": \"<string>\",\n \"twitterDescription\": \"<string>\",\n \"twitterImageAlt\": \"<string>\",\n \"twitterSite\": \"<string>\",\n \"twitterCreator\": \"<string>\",\n \"themeColor\": \"<string>\"\n },\n \"navLinkBlockId\": \"<string>\"\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.tryarchitect.com/v0/pages")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["x-api-key"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"actions\": [\n {\n \"purpose\": \"<string>\",\n \"buttonTitle\": \"<string>\",\n \"actionType\": \"<string>\",\n \"url\": \"<string>\",\n \"actionId\": \"<string>\"\n }\n ],\n \"actionCardWidgets\": [],\n \"brandId\": \"<string>\",\n \"footerLinks\": [\n {\n \"links\": [\n {\n \"text\": \"<string>\",\n \"url\": \"<string>\",\n \"id\": \"<string>\"\n }\n ],\n \"title\": \"<string>\",\n \"id\": \"<string>\"\n }\n ],\n \"name\": \"<string>\",\n \"navLinks\": [],\n \"pageContext\": \"<string>\",\n \"pageType\": \"inbound\",\n \"scripts\": [],\n \"footerLinkBlockId\": \"<string>\",\n \"headerActionId\": \"<string>\",\n \"metadata\": {\n \"title\": \"<string>\",\n \"description\": \"<string>\",\n \"keywords\": [\n \"<string>\"\n ],\n \"author\": \"<string>\",\n \"robots\": [],\n \"canonicalUrl\": \"<string>\",\n \"ogTitle\": \"<string>\",\n \"ogDescription\": \"<string>\",\n \"ogImageAlt\": \"<string>\",\n \"ogSiteName\": \"<string>\",\n \"ogUrl\": \"<string>\",\n \"twitterTitle\": \"<string>\",\n \"twitterDescription\": \"<string>\",\n \"twitterImageAlt\": \"<string>\",\n \"twitterSite\": \"<string>\",\n \"twitterCreator\": \"<string>\",\n \"themeColor\": \"<string>\"\n },\n \"navLinkBlockId\": \"<string>\"\n}"
response = http.request(request)
puts response.read_body{
"actions": [
{
"actionId": "<string>",
"actionIndex": 123,
"purpose": "<string>",
"buttonTitle": "<string>",
"actionType": "<string>",
"url": "<string>"
}
],
"actionCardWidgets": [
{
"type": "<string>",
"title": "<string>",
"logos": [
{
"image": {
"altText": "<string>",
"url": "<string>",
"fileId": "2023-11-07T05:31:56Z",
"assetId": "2023-11-07T05:31:56Z"
}
}
]
}
],
"archivedAt": "2023-11-07T05:31:56Z",
"audiencesCount": 4503599627370495,
"brandId": "<string>",
"createdAt": "2023-11-07T05:31:56Z",
"deletedAt": "2023-11-07T05:31:56Z",
"footerLinkBlockId": "<string>",
"footerLinks": [
{
"links": [
{
"text": "<string>",
"url": "<string>",
"id": "<string>"
}
],
"title": "<string>",
"id": "<string>"
}
],
"flags": [
"home_page"
],
"name": "<string>",
"navLinkBlockId": "<string>",
"navLinks": [
{
"type": "<string>",
"text": "<string>",
"url": "<string>",
"id": "<string>"
}
],
"pageContext": "<string>",
"pageId": "<string>",
"scripts": [
{
"content": "<string>",
"enabled": true,
"name": "<string>",
"description": "<string>"
}
],
"title": "<string>",
"updatedAt": "2023-11-07T05:31:56Z",
"headerActionId": "<string>",
"metadata": {
"title": "<string>",
"description": "<string>",
"keywords": [
"<string>"
],
"author": "<string>",
"robots": [],
"canonicalUrl": "<string>",
"ogTitle": "<string>",
"ogDescription": "<string>",
"ogImageUrl": "<string>",
"ogImageFileId": "<string>",
"ogImageAlt": "<string>",
"ogSiteName": "<string>",
"ogUrl": "<string>",
"twitterTitle": "<string>",
"twitterDescription": "<string>",
"twitterImageUrl": "<string>",
"twitterImageFileId": "<string>",
"twitterImageAlt": "<string>",
"twitterSite": "<string>",
"twitterCreator": "<string>",
"themeColor": "<string>"
}
}{
"code": "VALIDATION_ERROR",
"detail": "body - name: Name is required; email: Invalid email address",
"details": [
{
"field": "body",
"issues": [
{
"code": "validation_failed",
"message": "name: Name is required",
"path": [
"name"
]
}
]
}
],
"requestId": "req_01j5k9m7n8p9q2r3s4t5v6w7x8",
"status": 400,
"title": "Bad Request",
"type": "https://api.tryarchitect.com/errors/validation_error"
}{
"code": "UNAUTHORIZED",
"detail": "Authentication is required",
"requestId": "req_01j5k9m7n8p9q2r3s4t5v6w7x8",
"status": 401,
"title": "Unauthorized",
"type": "https://api.tryarchitect.com/errors/unauthorized"
}{
"code": "FORBIDDEN",
"detail": "Multi-tenant API keys are not supported",
"requestId": "req_01j5k9m7n8p9q2r3s4t5v6w7x8",
"status": 403,
"title": "Forbidden",
"type": "https://api.tryarchitect.com/errors/forbidden"
}{
"code": "CONFLICT",
"detail": "Default topic titles cannot be updated",
"requestId": "req_01j5k9m7n8p9q2r3s4t5v6w7x8",
"status": 409,
"title": "Conflict",
"type": "https://api.tryarchitect.com/errors/conflict"
}{
"code": "RATE_LIMITED",
"detail": "Rate limit exceeded",
"details": {
"limit": 100,
"remaining": 0,
"resetTime": 1713225600000,
"retryAfter": 60
},
"requestId": "req_01j5k9m7n8p9q2r3s4t5v6w7x8",
"status": 429,
"title": "Too Many Requests",
"type": "https://api.tryarchitect.com/errors/rate_limited"
}{
"code": "INTERNAL",
"detail": "An unexpected error occurred",
"requestId": "req_01j5k9m7n8p9q2r3s4t5v6w7x8",
"status": 500,
"title": "Internal Server Error",
"type": "https://api.tryarchitect.com/errors/internal"
}{
"code": "SERVICE_UNAVAILABLE",
"detail": "The service is temporarily unavailable",
"requestId": "req_01j5k9m7n8p9q2r3s4t5v6w7x8",
"status": 503,
"title": "Service Unavailable",
"type": "https://api.tryarchitect.com/errors/service_unavailable"
}Authorizations
API key authentication for the External Actor Gateway
Body
application/json
- Option 1
- Option 2
- Option 3
Show child attributes
Show child attributes
- Option 1
- Option 2
Show child attributes
Show child attributes
Show child attributes
Show child attributes
Minimum string length:
1- Option 1
- Option 2
Show child attributes
Show child attributes
Minimum string length:
1Available options:
inbound, outbound, call_followup, sales_deck, custom Show child attributes
Show child attributes
Show child attributes
Show child attributes
Response
Page created successfully
- Option 1
- Option 2
- Option 3
Show child attributes
Show child attributes
- Option 1
- Option 2
Show child attributes
Show child attributes
Pattern:
^(?:(?:\d\d[2468][048]|\d\d[13579][26]|\d\d0[48]|[02468][048]00|[13579][26]00)-02-29|\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\d|30)|(?:02)-(?:0[1-9]|1\d|2[0-8])))T(?:(?:[01]\d|2[0-3]):[0-5]\d(?::[0-5]\d(?:\.\d+)?)?(?:Z))$Required range:
0 <= x <= 9007199254740991Pattern:
^(?:(?:\d\d[2468][048]|\d\d[13579][26]|\d\d0[48]|[02468][048]00|[13579][26]00)-02-29|\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\d|30)|(?:02)-(?:0[1-9]|1\d|2[0-8])))T(?:(?:[01]\d|2[0-3]):[0-5]\d(?::[0-5]\d(?:\.\d+)?)?(?:Z))$Pattern:
^(?:(?:\d\d[2468][048]|\d\d[13579][26]|\d\d0[48]|[02468][048]00|[13579][26]00)-02-29|\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\d|30)|(?:02)-(?:0[1-9]|1\d|2[0-8])))T(?:(?:[01]\d|2[0-3]):[0-5]\d(?::[0-5]\d(?:\.\d+)?)?(?:Z))$Show child attributes
Show child attributes
Available options:
home_page - Option 1
- Option 2
Show child attributes
Show child attributes
Available options:
inbound, outbound, call_followup, sales_deck, custom Show child attributes
Show child attributes
Available options:
archived, draft, published Pattern:
^(?:(?:\d\d[2468][048]|\d\d[13579][26]|\d\d0[48]|[02468][048]00|[13579][26]00)-02-29|\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\d|30)|(?:02)-(?:0[1-9]|1\d|2[0-8])))T(?:(?:[01]\d|2[0-3]):[0-5]\d(?::[0-5]\d(?:\.\d+)?)?(?:Z))$Show child attributes
Show child attributes
Related topics
Create page linkCreate Ad PagesCreate page link blockCreating Personalized ABM PagesChangelogWas this page helpful?
⌘I

