Skip to main content
PATCH
/
v0
/
pages
/
{page_id}
/
audiences
/
{audience_id}
Update audience
curl --request PATCH \
  --url https://api.tryarchitect.com/v0/pages/{page_id}/audiences/{audience_id} \
  --header 'Content-Type: application/json' \
  --header 'x-api-key: <api-key>' \
  --data '
{
  "actionFormIdOverride": "<string>",
  "actionFormInstructionsOverride": "<string>",
  "actionUrlOverride": "<string>",
  "customName": "<string>",
  "metadataOverride": {
    "title": "<string>",
    "description": "<string>",
    "keywords": [
      "<string>"
    ],
    "author": "<string>",
    "robots": [
      "index"
    ],
    "canonicalUrl": "<string>",
    "ogTitle": "<string>",
    "ogDescription": "<string>",
    "ogType": "website",
    "ogImageAlt": "<string>",
    "ogSiteName": "<string>",
    "ogUrl": "<string>",
    "twitterCard": "summary",
    "twitterTitle": "<string>",
    "twitterDescription": "<string>",
    "twitterImageAlt": "<string>",
    "twitterSite": "<string>",
    "twitterCreator": "<string>",
    "themeColor": "<string>"
  },
  "supplementaryContext": "<string>"
}
'
{
  "actionFormIdOverride": "<string>",
  "actionFormInstructionsOverride": "<string>",
  "actionUrlOverride": "<string>",
  "archivedAt": "<string>",
  "audienceId": "<string>",
  "computedName": "<string>",
  "createdAt": "<string>",
  "customName": "<string>",
  "effectiveName": "<string>",
  "isNewPageAgent": true,
  "latestVersion": {
    "archivedAt": "<string>",
    "audienceId": "<string>",
    "becameDraftAt": "<string>",
    "cancelledAt": "<string>",
    "createdAt": "<string>",
    "isNewPageAgent": true,
    "obsoleteAt": "<string>",
    "publishedAt": "<string>",
    "queueDurationMs": 123,
    "queuedAt": "<string>",
    "status": "archived",
    "supplementaryContext": "<string>",
    "versionId": "<string>",
    "versionNumber": 123
  },
  "pageId": "<string>",
  "personId": "<string>",
  "personRouteKey": "<string>",
  "publishedVersion": {
    "archivedAt": "<string>",
    "audienceId": "<string>",
    "becameDraftAt": "<string>",
    "cancelledAt": "<string>",
    "createdAt": "<string>",
    "isNewPageAgent": true,
    "obsoleteAt": "<string>",
    "publishedAt": "<string>",
    "queueDurationMs": 123,
    "queuedAt": "<string>",
    "status": "archived",
    "supplementaryContext": "<string>",
    "versionId": "<string>",
    "versionNumber": 123
  },
  "status": "archived",
  "supplementaryContext": "<string>",
  "effectiveMetadata": {
    "title": "<string>",
    "description": "<string>",
    "keywords": [
      "<string>"
    ],
    "author": "<string>",
    "robots": [
      "index"
    ],
    "canonicalUrl": "<string>",
    "ogTitle": "<string>",
    "ogDescription": "<string>",
    "ogType": "website",
    "ogImageUrl": "<string>",
    "ogImageFileId": "<string>",
    "ogImageAlt": "<string>",
    "ogSiteName": "<string>",
    "ogUrl": "<string>",
    "twitterCard": "summary",
    "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": [
      "index"
    ],
    "canonicalUrl": "<string>",
    "ogTitle": "<string>",
    "ogDescription": "<string>",
    "ogType": "website",
    "ogImageUrl": "<string>",
    "ogImageFileId": "<string>",
    "ogImageAlt": "<string>",
    "ogSiteName": "<string>",
    "ogUrl": "<string>",
    "twitterCard": "summary",
    "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

​
audience_id
string
required

audience_id parameter

Body

application/json
​
actionFormIdOverride
string | null
​
actionFormInstructionsOverride
string | null
​
actionUrlOverride
string<uri> | null

URL to open when action is triggered

​
customName
string | null
Minimum string length: 1
​
metadataOverride
object
​
supplementaryContext
string | null
Minimum string length: 1

Response

Audience created successfully

​
actionFormIdOverride
string | null
required
​
actionFormInstructionsOverride
string | null
required
​
actionUrlOverride
string | null
required
​
archivedAt
string | null
required
Pattern: ^\+[1-9]\d{1,14}$
​
audienceId
string
required
​
computedName
string
required
​
createdAt
string
required
Pattern: ^\+[1-9]\d{1,14}$
​
customName
string | null
required
​
effectiveName
string
required
​
isNewPageAgent
boolean
required
​
latestVersion
object
required
​
pageId
string
required
​
personId
string | null
required
​
personRouteKey
string | null
required
​
publishedVersion
object
required
​
status
enum<string>
required
Available options:
archived,
cancelled,
draft,
pending,
processing,
published,
queued
​
supplementaryContext
string | null
required
​
effectiveMetadata
object
​
metadataOverride
object