Skip to main content
POST
Create website key page

Authorizations

Authorization
string
header
required

Access token issued by gs.service.id. Its access_identity claim carries team_sid, actor_sid and actor_type, and that team scope is authoritative.

Team-SID
string
header
required

Team scope for tokens that do not carry one. Ignored when the token already names a team.

Body

application/json

Request body of create_website_key_page.

site_sid
string
required

Website site sid (sg_si_...), the page's site.

Required string length: 18
Pattern: ^sg_si_
key
string
required

A stable lowercase slug, unique within the site, immutable: the name facts, the key_page filter and the signal visited_key_page carry.

Maximum string length: 64
Pattern: ^[a-z0-9][a-z0-9_-]*$
label
string
required

What the page is called in the feed (Pricing).

Required string length: 1 - 120
pattern
string
required

A path glob or a pasted URL (reduced to its path): * stands for any run of characters, matching ignores case and a trailing slash (/plans*). No path readable is 422 invalid_pattern.

Maximum string length: 2048
is_conversion
boolean

Count a visit as a conversion. Default false: visiting /signup is not a signup.

Response

create success envelope.

success
enum<boolean>
required
Available options:
true
operation
enum<string>
required
Available options:
create
item
object
required
already_exists
boolean
required
meta
object
required