Skip to main content
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>",
  "pageContext": "<string>",
  "pageType": "inbound",
  "scripts": [],
  "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>"
  }
}
'
{
  "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": "<string>",
            "assetId": "<string>"
          }
        }
      ]
    }
  ],
  "archivedAt": "<string>",
  "audiencesCount": 4503599627370495,
  "brandId": "<string>",
  "createdAt": "<string>",
  "deletedAt": "<string>",
  "footerLinks": [
    {
      "links": [
        {
          "text": "<string>",
          "url": "<string>",
          "id": "<string>"
        }
      ],
      "title": "<string>",
      "id": "<string>"
    }
  ],
  "name": "<string>",
  "pageContext": "<string>",
  "pageId": "<string>",
  "scripts": [
    {
      "content": "<string>",
      "enabled": true,
      "name": "<string>",
      "description": "<string>"
    }
  ],
  "tenantId": "<string>",
  "title": "<string>",
  "updatedAt": "<string>",
  "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>"
  }
}

Authorizations

​
x-api-key
string
header
required

API key authentication for the External Actor Gateway

Body

application/json
​
actions
object[]
required
​
actionCardWidgets
object[]
required
​
brandId
string
required
​
footerLinks
object[]
required
​
name
string
required
Minimum string length: 1
​
pageContext
string
required
Minimum string length: 1
​
pageType
enum<string>
default:inbound
required
Available options:
inbound,
outbound,
call_followup,
sales_deck,
custom
​
scripts
object[]
required
​
headerActionId
string
​
metadata
object

Response

201 - application/json

Page created successfully

​
actions
object[]
required
​
actionCardWidgets
object[]
required
​
archivedAt
string | null
required
Minimum string length: 1
Pattern: ^accountlog_[a-z0-9]{26}$
​
audiencesCount
integer
required
Required range: 0 <= x <= 9007199254740991
​
brandId
string
required
​
createdAt
string
required
Minimum string length: 1
Pattern: ^accountlog_[a-z0-9]{26}$
​
deletedAt
string | null
required
Minimum string length: 1
Pattern: ^accountlog_[a-z0-9]{26}$
​
footerLinks
object[]
required
​
name
string
required
​
pageContext
string
required
​
pageId
string
required
​
pageType
enum<string>
required
Available options:
inbound,
outbound,
call_followup,
sales_deck,
custom
​
scripts
object[]
required
​
status
enum<string>
required
Available options:
archived,
draft,
published
​
tenantId
string
required
​
title
string
required
​
updatedAt
string
required
Minimum string length: 1
Pattern: ^accountlog_[a-z0-9]{26}$
​
headerActionId
string
​
metadata
object