Skip to content

Create a content page preview link

POST
/stores/{storeRef}/content-pages/{id}/preview-token
curl --request POST \
--url https://apibase.ecomweb.app/api/v1/stores/example/content-pages/1/preview-token \
--header 'x-api-key: <x-api-key>'

Generates a signed URL, valid for 60 minutes, that shows the page on the storefront whether or not it is published. An unknown page ID is answered with 400.

Required scopes: write:pages

id
required
number

ID of the content page.

storeRef
required
string

The store’s ref, as returned by GET /stores.

Media typeapplication/json
object
preview_token
required

Signed token that lets the storefront show the page whatever its published state.

string
preview_url
required

Storefront URL of the page with the token attached.

string
expires_in
required

Seconds until the token expires.

number

Example generated

{
"preview_token": "example",
"preview_url": "example",
"expires_in": 1
}

The request is malformed or failed validation.

Media typeapplication/json
One of:
object
statusCode
required

The HTTP status code.

number
message
required

What went wrong; validation failures list one message per problem.

One of:
string
error

The HTTP status text, such as Bad Request.

string

Example generated

{
"statusCode": 1,
"message": [
"example"
],
"error": "example"
}

The key is missing, invalid, revoked or expired.

Media typeapplication/json
One of:
object
statusCode
required

The HTTP status code.

number
message
required

What went wrong; validation failures list one message per problem.

One of:
string
error

The HTTP status text, such as Bad Request.

string

Example generated

{
"statusCode": 1,
"message": [
"example"
],
"error": "example"
}

The key may not do this: a missing scope, a readonly key, a publishable key on a Store API route, or a disallowed origin.

Media typeapplication/json
One of:
object
statusCode
required

The HTTP status code.

number
message
required

What went wrong; validation failures list one message per problem.

One of:
string
error

The HTTP status text, such as Bad Request.

string

Example generated

{
"statusCode": 1,
"message": [
"example"
],
"error": "example"
}