Skip to main content
PATCH
Append metadata field

Authorizations

Authorization
string
header
required

Bearer token authentication

Path Parameters

id
integer
required

Page's Id

Body

application/json

Request payload

metadata
object | null

A JSON object that can store any custom data structure. When provided, merges with existing metadata data.

Response

Success

A company page.

id
integer

Page ID.

title
string | null

Page title in the request language.

slug
string | null

URL slug.

source
string | null

How the page is authored: code or builder.

publish
boolean | null

Whether the page is published.

active
boolean | null

Same as publish.

html_code
string | null

Page HTML.

json
any

Builder document for builder-authored pages, or null.

metadata
object | null

Free-form metadata.

email
string | null
image_url
string | null

Poster image URL, or the default placeholder.

preview_url
string | null

URL to preview the page on the storefront.

stripped_description
string | null

SEO description, or null.

use_search_engine
boolean | null

Whether search engines may index the page.

show_on_site_search
boolean | null

Whether the page appears in site search.

prompts_enabled
boolean | null
prompts
object[] | null

Share prompts.

countries
object[] | null

Countries the page is limited to; empty means all countries.

views
integer | null

Views of the caller's shares of this page.

leads
integer | null

Leads from the caller's shares of this page.

The caller's share link, if one exists.

label
object | null

Label shown on the page card, or null.

display_tag
string | null
application_theme_template
object | null

Theme template that renders the page, or null.

search_engine_optimizer
object | null

SEO settings, or null.

open_graph
object | null

Open Graph settings, or null.