Update page

Update a page.

PATCH /v0/pages/{page_id}

Update page

cURL

curl --request PATCH \
  --url https://api.tryarchitect.com/v0/pages/{page_id} \
  --header 'Content-Type: application/json' \
  --header 'x-api-key: <api-key>' \
  --data '
{
  "actions": [
    {
      "purpose": "<string>",
      "buttonTitle": "<string>",
      "actionType": "<string>",
      "url": "<string>",
      "actionId": "<string>"
    }
  ],
  "actionCardWidgets": [
    {
      "type": "<string>",
      "title": "<string>",
      "logos": [
        {
          "image": {
            "altText": "<string>",
            "url": "<string>",
            "fileId": "<string>",
            "assetId": "<string>"
          }
        }
      ]
    }
  ],
  "brandId": "<string>",
  "footerLinks": [
    {
      "links": [
        {
          "text": "<string>",
          "url": "<string>",
          "id": "<string>"
        }
      ],
      "title": "<string>",
      "id": "<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>"
  },
  "name": "<string>",
  "pageContext": "<string>",
  "scripts": [
    {
      "content": "<string>",
      "enabled": true,
      "name": "<string>",
      "description": "<string>"
    }
  ]
}
'

200

{
  "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>"
    }
  ],
  "flags": [],
  "name": "<string>",
  "pageContext": "<string>",
  "pageId": "<string>",
  "scripts": [
    {
      "content": "<string>",
      "enabled": true,
      "name": "<string>",
      "description": "<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

Path Parameters

page_id · string · required

page_id parameter

Body

application/json

actions · object[]

Option 1

Option 2

Option 3

Show child attributes

actionCardWidgets · object[]

Option 1

Option 2

Show child attributes

brandId · string

footerLinks · object[]

Show child attributes

headerActionId · string | null

metadata · object

Show child attributes

name · string

Minimum string length: 1

pageContext · string

Minimum string length: 1

pageType · enum<string>

Available options: inbound, outbound, call_followup, sales_deck, custom

scripts · object[]

Show child attributes

Response

200

application/json

Page created successfully

actions · object[] · required

Option 1

Option 2

Option 3

Show child attributes

actionCardWidgets · object[] · required

Option 1

Option 2

Show child attributes

archivedAt · string | null · required

Pattern: ^\+[1-9]\d{1,14}$

audiencesCount · integer · required

Required range: 0 <= x <= 9007199254740991

brandId · string · required

createdAt · string · required

Pattern: ^\+[1-9]\d{1,14}$

deletedAt · string | null · required

Pattern: ^\+[1-9]\d{1,14}$

footerLinks · object[] · required

Show child attributes

flags · enum<string>[] · required

Available options: home_page

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

Show child attributes

status · enum<string> · required

Available options: archived, draft, published

title · string · required

updatedAt · string · required

Pattern: ^\+[1-9]\d{1,14}$

headerActionId · string

metadata · object

Show child attributes