PATCH /pages/{page_id}

Update a Page in a provided Project

Servers

Path parameters

Name Type Required Description
page_id Integer Yes

The Page ID of the Page you want to change

Request headers

Name Type Required Description
Content-Type String Yes The media type of the request body.

Default value: "application/json"

Request body fields

Name Type Required Description
page_type String No

Type of Page

Valid values:

  • "url_set"
  • "global"
  • "single_url"
category String No

The category this Page is grouped under

Valid values:

  • "landing_page"
  • "product_detail"
  • "home"
  • "cart"
  • "checkout"
  • "other"
  • "category"
  • "article"
  • "search_results"
  • "pricing"
activation_type String No

Page activation type is a trigger that determines when the page is activated. Triggers tell Optimizely when to start checking whether certain conditions are true 'Immediate' activation mode activates the page as soon as the snippet loads. 'Polling' activation mode polls every 50ms until 'activation_code' evaluates to True, then activates the page. 'Callback' activation mode activates the page when the event defined by 'activation_code' is triggered. 'Manual' activation mode requires code within the subject app to explicitly trigger page activation. 'DOM Changed' sets the page to trigger when the DOM changes Learn more. 'URL Changed' sets the page to trigger when the URL changes Learn more.

Valid values:

  • "manual"
  • "url_changed"
  • "immediate"
  • "callback"
  • "polling"
  • "dom_changed"
name String No

Page Name

archived Boolean No

Whether the Page is archived

key String No

Unique string identifier for this Page within the Project

activation_code String No

Stringified Javascript function that determines when the Page is activated. Only required when activation_type is 'polling' or 'callback'.

conditions String No

Stringified array of the conditions that activate the Page. The array contains Page Condition JSON dicts joined by "and" and "or". Each individual Page Condition dict has format {"type": "url", "match_type": <match_type>, "value": } where match_types are: "simple" match type will match if "value" matches the hostname and path of the Page URL. "exact" match type will match only an exact string match between "value" and the Page URL. "substring" match type will match if "value" is a substring of the Page URL. "regex" match type will match if "value" is a regular expression match for the Page URL.

edit_url String No

URL of the Page

How to start integrating

  1. Add HTTP Task to your workflow definition.
  2. Search for the API you want to integrate with and click on the name.
    • This loads the API reference documentation and prepares the Http request settings.
  3. Click Test request to test run your request to the API and see the API's response.