Skip to main content
PATCH
Update 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.

Path Parameters

sid
string
required

Website key page sid (sg_kp_...).

Required string length: 18
Pattern: ^sg_kp_

Body

application/json

Request body of update_website_key_page.

label
string

Replacement label.

Required string length: 1 - 120
pattern
string

Replacement path glob or URL; applies to visits from then on.

Maximum string length: 2048
is_conversion
boolean

Flag or unflag the page as a conversion.

Response

update success envelope.

success
enum<boolean>
required
Available options:
true
operation
enum<string>
required
Available options:
update
item
object
required
updated_fields
string[]
required
previous_values
object
required
meta
object
required
kept_fields
string[]

The fields this write did not change because the person's own value stands on them (stamped person); read the item for what landed.