Skip to main content
POST
/
v0
/
pages
/
{page_id}
/
audiences
/
{audience_id}
/
versions
/
{version_id}
/
cancel
Cancel audience version
curl --request POST \
  --url https://api.tryarchitect.com/v0/pages/{page_id}/audiences/{audience_id}/versions/{version_id}/cancel \
  --header 'Content-Type: application/json' \
  --header 'x-api-key: <api-key>' \
  --data '{}'
{
  "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
}

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

​
version_id
string
required

version_id parameter

Body

application/json

The body is of type object.

Response

AudienceVersion created successfully

​
archivedAt
string | null
required
Pattern: ^\+[1-9]\d{1,14}$
​
audienceId
string
required
​
becameDraftAt
string | null
required
Pattern: ^\+[1-9]\d{1,14}$
​
cancelledAt
string | null
required
Pattern: ^\+[1-9]\d{1,14}$
​
createdAt
string
required
Pattern: ^\+[1-9]\d{1,14}$
​
isNewPageAgent
boolean
required
​
obsoleteAt
string | null
required
Pattern: ^\+[1-9]\d{1,14}$
​
publishedAt
string | null
required
Pattern: ^\+[1-9]\d{1,14}$
​
queueDurationMs
number | null
required
​
queuedAt
string | null
required
Pattern: ^\+[1-9]\d{1,14}$
​
status
enum<string>
required
Available options:
archived,
cancelled,
draft,
pending,
processing,
published,
queued
​
supplementaryContext
string | null
required
​
versionId
string
required
​
versionNumber
integer
required
Required range: x <= 9007199254740991