Cancel audience version

Cancel an audience version and keep it as a draft.

POST /v0/pages/{page_id}/audiences/{audience_id}/versions/{version_id}/cancel

Cancel audience version

cURL

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 '{}'

200

{
  "archivedAt": "<string>",
  "audienceId": "<string>",
  "becameDraftAt": "<string>",
  "cancelledAt": "<string>",
  "createdAt": "<string>",
  "isNewPageAgent": true,
  "obsoleteAt": "<string>",
  "publishedAt": "<string>",
  "queueDurationMs": 123,
  "queuedAt": "<string>",
  "supplementaryContext": "<string>",
  "tenantId": "<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

200 - application/json

AudienceVersion created successfully

archivedAt · string | null · required

Minimum string length: 1

Pattern: ^accountlog_[a-z0-9]{26}$

audienceId · string · required

becameDraftAt · string | null · required

Minimum string length: 1

Pattern: ^accountlog_[a-z0-9]{26}$

cancelledAt · string | null · required

Minimum string length: 1

Pattern: ^accountlog_[a-z0-9]{26}$

createdAt · string · required

Minimum string length: 1

Pattern: ^accountlog_[a-z0-9]{26}$

isNewPageAgent · boolean · required

obsoleteAt · string | null · required

Minimum string length: 1

Pattern: ^accountlog_[a-z0-9]{26}$

publishedAt · string | null · required

Minimum string length: 1

Pattern: ^accountlog_[a-z0-9]{26}$

queueDurationMs · number | null · required

queuedAt · string | null · required

Minimum string length: 1

Pattern: ^accountlog_[a-z0-9]{26}$

status · enum<string> · required

Available options: archived, cancelled, draft, pending, processing, published, queued

supplementaryContext · string | null · required

tenantId · string · required

versionId · string · required

versionNumber · integer · required

Required range: x <= 9007199254740991