Update recommendation page

patch

https://ac.cnstrc.com/v1/recommendation_pages/{page_id}

🔐 This endpoint requires HTTP authentication (either Basic or Bearer).
For authenticating with Bearer token, required scopes are: recommendations(w).

Beta: This endpoint is in beta and may change. It is currently available to a small group of users. To request access, contact your Customer Success Manager.

Update the supplied fields of a page, leaving the rest as they are. pods, when supplied, replaces the complete ordered list: it cannot be patched in part, [] empties the page and keeps its other settings, and null is rejected. metadata_json is merged recursively into the page's current settings, and a null leaf restores that setting's default.

Answers 404 if the page, or a pod in pods, is not configured for this key and section, and 400 if pods repeats a pod or lists more pods than the page limit.

Path Params

page_id

string

required

Query Params

key

string

required

length between 1 and 100

The key of the index to use.

section

string

length between 1 and 100

The section of the index to use. Defaults to Products.

string

length between 1 and 100

The ID of the client and version that the request is coming from, such as cio-js-2.90.

Body Params

The fields of a page to change; the rest are left as they are.

display_name

string

length between 2 and 100

The name of the page displayed to merchandisers, between 2 and 100 characters. Surrounding whitespace is stripped.

page_type

string

enum

The role the page plays in the storefront. It is metadata only and does not affect retrieval behavior today.

pods

array of objects, unique

Pods to serve on this page, listed in the order a shopper sees them: top to bottom, then left to right for pods that sit side by side. Page results return the pods in this order, and a retrieval request cannot reorder them. Items are deduplicated between pods in the same page; which pod keeps an ordinary (non-slotted) item is decided by Constructor, so slot an item to guarantee it stays in a particular pod. Include at most 5 pods, or fewer where a lower limit is configured for the page; each must already be configured for this key and section, and no pod may appear twice. A page with no pods returns an empty pods list. A write that supplies pods replaces the complete list.

Pods

metadata_json

object

Merged recursively into the settings the page already has rather than replacing them. A null leaf deletes that setting and restores its default.

Responses

400

Validation Error

401

Credentials are not passed or action is forbidden.

403

The supplied token does not have the required permissions.

404

Not Found

429

Rate limit breached

Language

Credentials

Loading…

Response

Choose an example:

application/json

👋 Welcome to Constructor's new and improved documentation

200OK