Skip to content
For the complete documentation index, see llms.txt. This page is also available as Markdown.

Update a special page

Fully replaces a special page. name, url, product_collection and extraction_strategy are required, as on create; on multi-language sites (PRETTY_URL_MULTI_LANGUAGE on) specialpageprettyurl_set is required as well.

  • The pretty URL is regenerated from the new url.

  • Setting is_active to false on an active page removes its pretty URL, and the items of specialpageprettyurl_set are not applied in that request.

  • Items of specialpageprettyurl_set replace the URL of their language; languages that are not sent keep their URL.

  • Translatable fields are written in the language selected for the request (IGNORE_ACCEPT_LANGUAGE_HEADER). In a language other than the default one they are stored as a translation and the default-language values are left unchanged.

put
/special_pages/{id}/
Authorizations
AuthorizationstringRequired

Token credential sent in the Authorization header, in the form: Token <your-token>. Requires a staff (admin) account.

Path parameters
idintegerRequired

The unique identifier of the special page.

Body

The body of a create or full-update request sent as JSON. Images cannot be uploaded in JSON; use multipart/form-data for banner and banner_mobile.

specialpageprettyurl_set is additionally required on multi-language sites (PRETTY_URL_MULTI_LANGUAGE on) and ignored on single-language sites.

namestring · max: 64Required

The name of the page. Stored in the language selected for the request.

urlstring · max: 512Required

The URL of the page. Must not be the URL of another special page or the path of another pretty URL. Turkish characters are not accepted.

templatestring · max: 512 · nullableOptional

The storefront template used to render the page.

bannernullOptional

Send null to remove the desktop banner image.

banner_mobilenullOptional

Send null to remove the mobile banner image.

banner_urlstring · max: 512 · nullableOptional

The link the banner points to. Stored in the language selected for the request.

product_collectionintegerRequired

The identifier of an existing product collection.

banner_descriptionstring · nullableOptional

The text shown with the banner. Stored in the language selected for the request.

is_activebooleanOptional

Whether the page is active.

Default: true
video_embedded_codestring · max: 512 · nullableOptional

Embed code of a video shown on the page. Stored in the language selected for the request.

extraction_strategystring,null · enum · nullableRequired

The product extraction strategy to use for the page. Either the short name or the full value is accepted; send null to use the site-wide default (SPECIAL_PAGE_EXTRACTION_STRATEGY). Any other value is rejected with 400.

Possible values:
Responses
200

The updated special page.

application/json

A special page.

pkintegerRead-onlyOptional

The unique identifier of the special page.

namestring · max: 64Optional

The name of the page. Translatable.

Example: Summer Sale
urlstring · max: 512Optional

The URL of the page; its pretty URL is generated from it. Unique across special pages. Turkish characters are not accepted.

Example: /summer-sale/
templatestring · max: 512 · nullableOptional

The storefront template used to render the page.

bannerstring · nullableOptional

URL of the desktop banner image. Translatable.

banner_mobilestring · nullableOptional

URL of the mobile banner image. Translatable.

banner_urlstring · max: 512 · nullableOptional

The link the banner points to. Translatable.

product_collectionintegerOptional

The identifier of the product collection whose products the page lists.

Example: 12
banner_descriptionstring · nullableOptional

The text shown with the banner. Translatable.

is_activebooleanOptional

Whether the page is active. Inactive pages have no pretty URL. Deleted pages are inactive.

created_datestring · date-timeRead-onlyOptional

When the page was created.

modified_datestring · date-timeRead-onlyOptional

When the page was last modified.

video_embedded_codestring · max: 512 · nullableOptional

Embed code of a video shown on the page. Translatable.

extraction_strategystring,null · enum · nullableOptional

The product extraction strategy of the page, returned as its full value. null means the site-wide default (SPECIAL_PAGE_EXTRACTION_STRATEGY) is used. See Product Extraction Strategy in the Special Pages section.

Possible values:
put/special_pages/{id}/
PUT /api/v1/remote/1/special_pages/{id}/ HTTP/1.1
Host: sandbox.akinon.com
Authorization: YOUR_API_KEY
Content-Type: application/json
Accept: */*
Content-Length: 297

{
  "name": "text",
  "url": "text",
  "template": null,
  "banner": null,
  "banner_mobile": null,
  "banner_url": null,
  "product_collection": 1,
  "banner_description": null,
  "is_active": true,
  "video_embedded_code": null,
  "extraction_strategy": "default",
  "specialpageprettyurl_set": [
    {
      "url": "/en/summer-sale/",
      "language": "en-us"
    }
  ]
}
{
  "pk": 1,
  "name": "Summer Sale",
  "url": "/summer-sale/",
  "template": null,
  "banner": null,
  "banner_mobile": null,
  "banner_url": null,
  "product_collection": 12,
  "banner_description": null,
  "is_active": true,
  "created_date": "2026-01-01T00:00:00.000Z",
  "modified_date": "2026-01-01T00:00:00.000Z",
  "video_embedded_code": null,
  "specialpageprettyurl_set": [
    {
      "pk": 1,
      "url": "/en/summer-sale/",
      "language": "en-us"
    }
  ],
  "pretty_url": {
    "pk": 1,
    "new_path": "/summer-sale/",
    "old_path": "/special-page/42/",
    "parent": null,
    "language": "tr-tr",
    "func_module": null,
    "func_name": null,
    "func_initkwargs": {},
    "args": [
      "text"
    ],
    "kwargs": {
      "special_page_id": 42
    },
    "query_params": {},
    "viewname": "special-page-detail",
    "created_date": "2026-01-01T00:00:00.000Z",
    "modified_date": "2026-01-01T00:00:00.000Z",
    "prettyurl_set": [
      {
        "pk": 1,
        "new_path": "text",
        "language": "text"
      }
    ]
  },
  "extraction_strategy": "omnishop.search.strategies.DefaultProductExtractionStrategy"
}

Last updated

Was this helpful?