Create page link

Create a page link.

POST /v0/page_links

Create page link

cURL

curl --request POST \
  --url https://api.tryarchitect.com/v0/page_links \
  --header 'Content-Type: application/json' \
  --header 'x-api-key: <api-key>' \
  --data '
{
  "path": "<string>",
  "target": {
    "targetType": "<string>",
    "audienceId": "<string>"
  },
  "tenantDomainId": "<string>"
}
'

200

{
  "pageLinkId": "<string>",
  "tenantDomainId": "<string>",
  "path": "<string>",
  "target": {
    "targetType": "<string>",
    "audienceId": "<string>"
  },
  "createdAt": "<string>",
  "updatedAt": "<string>",
  "deletedAt": "<string>"
}

Authorizations

x-api-key · string · header · required

API key authentication for the External Actor Gateway

Body

application/json

path · string · required

Minimum string length: 1

target · object · required

Option 1

Option 2

Option 3

Show child attributes

tenantDomainId · string | null

Response

200

application/json

Successful operation

pageLinkId · string · required

tenantDomainId · string | null · required

path · string · required

target · object · required

Option 1

Option 2

Option 3

Show child attributes

createdAt · string · required

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

updatedAt · string · required

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

deletedAt · string | null · required

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