Create audience
curl --request POST \
--url https://api.tryarchitect.com/v0/pages/{page_id}/audiences \
--header 'Content-Type: application/json' \
--header 'x-api-key: <api-key>' \
--data '
{
"publishBehavior": "publish",
"actionFormIdOverride": "<string>",
"actionFormInstructionsOverride": "<string>",
"actionUrlOverride": "<string>",
"customName": "<string>",
"metadataOverride": {
"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>"
},
"personId": "<string>",
"supplementaryContext": "<string>"
}
'import requests
url = "https://api.tryarchitect.com/v0/pages/{page_id}/audiences"
payload = {
"publishBehavior": "publish",
"actionFormIdOverride": "<string>",
"actionFormInstructionsOverride": "<string>",
"actionUrlOverride": "<string>",
"customName": "<string>",
"metadataOverride": {
"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>"
},
"personId": "<string>",
"supplementaryContext": "<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({
publishBehavior: 'publish',
actionFormIdOverride: '<string>',
actionFormInstructionsOverride: '<string>',
actionUrlOverride: '<string>',
customName: '<string>',
metadataOverride: {
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>'
},
personId: '<string>',
supplementaryContext: '<string>'
})
};
fetch('https://api.tryarchitect.com/v0/pages/{page_id}/audiences', 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/{page_id}/audiences",
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([
'publishBehavior' => 'publish',
'actionFormIdOverride' => '<string>',
'actionFormInstructionsOverride' => '<string>',
'actionUrlOverride' => '<string>',
'customName' => '<string>',
'metadataOverride' => [
'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>'
],
'personId' => '<string>',
'supplementaryContext' => '<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/{page_id}/audiences"
payload := strings.NewReader("{\n \"publishBehavior\": \"publish\",\n \"actionFormIdOverride\": \"<string>\",\n \"actionFormInstructionsOverride\": \"<string>\",\n \"actionUrlOverride\": \"<string>\",\n \"customName\": \"<string>\",\n \"metadataOverride\": {\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 \"personId\": \"<string>\",\n \"supplementaryContext\": \"<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/{page_id}/audiences")
.header("x-api-key", "<api-key>")
.header("Content-Type", "application/json")
.body("{\n \"publishBehavior\": \"publish\",\n \"actionFormIdOverride\": \"<string>\",\n \"actionFormInstructionsOverride\": \"<string>\",\n \"actionUrlOverride\": \"<string>\",\n \"customName\": \"<string>\",\n \"metadataOverride\": {\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 \"personId\": \"<string>\",\n \"supplementaryContext\": \"<string>\"\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.tryarchitect.com/v0/pages/{page_id}/audiences")
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 \"publishBehavior\": \"publish\",\n \"actionFormIdOverride\": \"<string>\",\n \"actionFormInstructionsOverride\": \"<string>\",\n \"actionUrlOverride\": \"<string>\",\n \"customName\": \"<string>\",\n \"metadataOverride\": {\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 \"personId\": \"<string>\",\n \"supplementaryContext\": \"<string>\"\n}"
response = http.request(request)
puts response.read_body{
"actionFormIdOverride": "<string>",
"actionFormInstructionsOverride": "<string>",
"actionUrlOverride": "<string>",
"archivedAt": "2023-11-07T05:31:56Z",
"audienceId": "<string>",
"computedName": "<string>",
"createdAt": "2023-11-07T05:31:56Z",
"customName": "<string>",
"effectiveName": "<string>",
"flags": [
"home_page"
],
"isNewPageAgent": true,
"latestVersion": {
"archivedAt": "2023-11-07T05:31:56Z",
"audienceId": "<string>",
"becameDraftAt": "2023-11-07T05:31:56Z",
"cancelledAt": "2023-11-07T05:31:56Z",
"createdAt": "2023-11-07T05:31:56Z",
"isNewPageAgent": true,
"obsoleteAt": "2023-11-07T05:31:56Z",
"publishedAt": "2023-11-07T05:31:56Z",
"queueDurationMs": 123,
"queuedAt": "2023-11-07T05:31:56Z",
"supplementaryContext": "<string>",
"versionId": "<string>",
"versionNumber": 123
},
"pageId": "<string>",
"personId": "<string>",
"personRouteKey": "<string>",
"publishedVersion": {
"archivedAt": "2023-11-07T05:31:56Z",
"audienceId": "<string>",
"becameDraftAt": "2023-11-07T05:31:56Z",
"cancelledAt": "2023-11-07T05:31:56Z",
"createdAt": "2023-11-07T05:31:56Z",
"isNewPageAgent": true,
"obsoleteAt": "2023-11-07T05:31:56Z",
"publishedAt": "2023-11-07T05:31:56Z",
"queueDurationMs": 123,
"queuedAt": "2023-11-07T05:31:56Z",
"supplementaryContext": "<string>",
"versionId": "<string>",
"versionNumber": 123
},
"supplementaryContext": "<string>",
"effectiveMetadata": {
"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>"
},
"metadataOverride": {
"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": "NOT_FOUND",
"detail": "Audience not found",
"requestId": "req_01j5k9m7n8p9q2r3s4t5v6w7x8",
"status": 404,
"title": "Not Found",
"type": "https://api.tryarchitect.com/errors/not_found"
}{
"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"
}Audiences
Create audience
Create an audience in a page. Provide personId to link the audience to an existing person; the audience is then addressable by that person’s route key. Linking can only be set at creation time — updating an audience cannot change its person link.
POST
/
v0
/
pages
/
{page_id}
/
audiences
Create audience
curl --request POST \
--url https://api.tryarchitect.com/v0/pages/{page_id}/audiences \
--header 'Content-Type: application/json' \
--header 'x-api-key: <api-key>' \
--data '
{
"publishBehavior": "publish",
"actionFormIdOverride": "<string>",
"actionFormInstructionsOverride": "<string>",
"actionUrlOverride": "<string>",
"customName": "<string>",
"metadataOverride": {
"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>"
},
"personId": "<string>",
"supplementaryContext": "<string>"
}
'import requests
url = "https://api.tryarchitect.com/v0/pages/{page_id}/audiences"
payload = {
"publishBehavior": "publish",
"actionFormIdOverride": "<string>",
"actionFormInstructionsOverride": "<string>",
"actionUrlOverride": "<string>",
"customName": "<string>",
"metadataOverride": {
"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>"
},
"personId": "<string>",
"supplementaryContext": "<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({
publishBehavior: 'publish',
actionFormIdOverride: '<string>',
actionFormInstructionsOverride: '<string>',
actionUrlOverride: '<string>',
customName: '<string>',
metadataOverride: {
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>'
},
personId: '<string>',
supplementaryContext: '<string>'
})
};
fetch('https://api.tryarchitect.com/v0/pages/{page_id}/audiences', 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/{page_id}/audiences",
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([
'publishBehavior' => 'publish',
'actionFormIdOverride' => '<string>',
'actionFormInstructionsOverride' => '<string>',
'actionUrlOverride' => '<string>',
'customName' => '<string>',
'metadataOverride' => [
'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>'
],
'personId' => '<string>',
'supplementaryContext' => '<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/{page_id}/audiences"
payload := strings.NewReader("{\n \"publishBehavior\": \"publish\",\n \"actionFormIdOverride\": \"<string>\",\n \"actionFormInstructionsOverride\": \"<string>\",\n \"actionUrlOverride\": \"<string>\",\n \"customName\": \"<string>\",\n \"metadataOverride\": {\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 \"personId\": \"<string>\",\n \"supplementaryContext\": \"<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/{page_id}/audiences")
.header("x-api-key", "<api-key>")
.header("Content-Type", "application/json")
.body("{\n \"publishBehavior\": \"publish\",\n \"actionFormIdOverride\": \"<string>\",\n \"actionFormInstructionsOverride\": \"<string>\",\n \"actionUrlOverride\": \"<string>\",\n \"customName\": \"<string>\",\n \"metadataOverride\": {\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 \"personId\": \"<string>\",\n \"supplementaryContext\": \"<string>\"\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.tryarchitect.com/v0/pages/{page_id}/audiences")
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 \"publishBehavior\": \"publish\",\n \"actionFormIdOverride\": \"<string>\",\n \"actionFormInstructionsOverride\": \"<string>\",\n \"actionUrlOverride\": \"<string>\",\n \"customName\": \"<string>\",\n \"metadataOverride\": {\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 \"personId\": \"<string>\",\n \"supplementaryContext\": \"<string>\"\n}"
response = http.request(request)
puts response.read_body{
"actionFormIdOverride": "<string>",
"actionFormInstructionsOverride": "<string>",
"actionUrlOverride": "<string>",
"archivedAt": "2023-11-07T05:31:56Z",
"audienceId": "<string>",
"computedName": "<string>",
"createdAt": "2023-11-07T05:31:56Z",
"customName": "<string>",
"effectiveName": "<string>",
"flags": [
"home_page"
],
"isNewPageAgent": true,
"latestVersion": {
"archivedAt": "2023-11-07T05:31:56Z",
"audienceId": "<string>",
"becameDraftAt": "2023-11-07T05:31:56Z",
"cancelledAt": "2023-11-07T05:31:56Z",
"createdAt": "2023-11-07T05:31:56Z",
"isNewPageAgent": true,
"obsoleteAt": "2023-11-07T05:31:56Z",
"publishedAt": "2023-11-07T05:31:56Z",
"queueDurationMs": 123,
"queuedAt": "2023-11-07T05:31:56Z",
"supplementaryContext": "<string>",
"versionId": "<string>",
"versionNumber": 123
},
"pageId": "<string>",
"personId": "<string>",
"personRouteKey": "<string>",
"publishedVersion": {
"archivedAt": "2023-11-07T05:31:56Z",
"audienceId": "<string>",
"becameDraftAt": "2023-11-07T05:31:56Z",
"cancelledAt": "2023-11-07T05:31:56Z",
"createdAt": "2023-11-07T05:31:56Z",
"isNewPageAgent": true,
"obsoleteAt": "2023-11-07T05:31:56Z",
"publishedAt": "2023-11-07T05:31:56Z",
"queueDurationMs": 123,
"queuedAt": "2023-11-07T05:31:56Z",
"supplementaryContext": "<string>",
"versionId": "<string>",
"versionNumber": 123
},
"supplementaryContext": "<string>",
"effectiveMetadata": {
"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>"
},
"metadataOverride": {
"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": "NOT_FOUND",
"detail": "Audience not found",
"requestId": "req_01j5k9m7n8p9q2r3s4t5v6w7x8",
"status": 404,
"title": "Not Found",
"type": "https://api.tryarchitect.com/errors/not_found"
}{
"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
Path Parameters
page_id parameter
Body
application/json
Available options:
draft, publish URL to open when action is triggered
Minimum string length:
1Show child attributes
Show child attributes
Optional person to link this audience to. When set, the audience is created linked to the person so that it is addressable by the person's route key and appears under the person. The person must already exist for the authenticated tenant.
Minimum string length:
1Minimum string length:
1Response
Audience created successfully
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))$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))$Available options:
home_page Show child attributes
Show child attributes
Show child attributes
Show child attributes
Available options:
archived, cancelled, draft, pending, processing, published, queued Show child attributes
Show child attributes
Show child attributes
Show child attributes
Related topics
Create audience versionChangelogCreate page linkMCP IntegrationCreate webhook subscriptionWas this page helpful?
⌘I