Journey Docs
Partner API ExplorerPages

Replace page SEO metadata

Required scopepartner:pages:manage
PUT
/v1/partner/pages/{pageGroupId}/seo

Full replacement. Custom header and footer HTML is sanitized before it is stored.

Authorization

headerAuthorizationBearer <token>

WorkOS access token (JWT) for a user who is a member of the partner organization. The organization the request is scoped to is taken from the token, not from a header or query parameter.

Only a JWT is accepted in this header. A Journey jny_ API key sent as a bearer token is rejected with 401 Invalid or expired token; send it in X-API-Key instead.

WorkOS organization API keys are not accepted yet.

Path Parameters

pageGroupId*string

External id of the page group.

Query Parameters

organizationId?string

Global (Journey staff) callers name the organization they act within.

Lengthlength <= 100
state?string

Which revision. Required when a page has both a draft and a published revision; otherwise the only revision is used.

Value in"draft""archived""published"

Request Body

application/json
  1. body
allowFollowing?boolean|null
allowIndexing?boolean|null
featuredImageUrl?|
Formaturi
Lengthlength <= 2048
footerHtml?string|null
headerHtml?string|null
metaDescription?|
Lengthlength <= 1000
titleTag?|
Lengthlength <= 255

Response Body

The stored SEO metadata.

curl -X PUT 'https://api-prd.cf.journey.com/v1/partner/pages/string/seo' \  -H 'Content-Type: application/json' \  -d '{}'
Empty