---
title: "Updates a custom page's fields."
---

> Documentation Index
> Fetch the complete documentation index at: https://docs.sherpo.io/llms.txt
> Use this file to discover all available pages before exploring further.

Path: Sherpo merchant API › custompage

`PATCH /v1/stores/{store}/pages/{page}`

## Authentication

- `bearer`, http, header `Authorization`, scopes: `custompage:write`

## Path parameters

- `store` (`updatePage.path.store`; string, required) — The store's id.
- `page` (`updatePage.path.page`; string, required) — An id, or `slug:<slug>`.
  - minLength 1

## Header parameters

- `Idempotency-Key` (`updatePage.header.Idempotency-Key`; string, optional) — Repeats within 24 hours answer the first result; the same key with other arguments is a conflict.
  - minLength 1; maxLength 255; pattern `^[\x21-\x7E]+$`

## Request body

_Optional._

- `slug` (`updatePage.slug`; string, optional) — Made from the title when absent: its words, numbered past a twin.
  - minLength 1; maxLength 120; pattern `^[a-z0-9]+(?:-[a-z0-9]+)*$`
- `title` (`updatePage.title`; string, optional)
  - minLength 1; maxLength 200
- `description` (`updatePage.description`; any of, optional)
  - any of: `string`, `null`
- `metadata` (`updatePage.metadata`; map<any of>, optional)
- `menu_position` (`updatePage.menu_position`; any of, optional)
  - any of: `integer`, `null`
- `full` (`updatePage.full`; boolean, optional) — Answers the texts, attachments and file lists the short answer leaves out.
- `settings` (`updatePage.settings`; object, optional) — Merged onto the stored settings; null deletes a key.
  - `storefront` (`updatePage.settings.storefront`; any of, optional)
    - any of: `object`, `null`

## Example request

```json
{
  "slug": "string",
  "title": "string",
  "description": "string",
  "metadata": {
    "property1": true,
    "property2": true
  },
  "menu_position": 1000000,
  "full": true,
  "settings": {
    "storefront": {
      "no_index": true
    },
    "property1": true,
    "property2": true
  }
}
```

## Code samples

### cURL

```bash
curl --request PATCH \
  --url 'https://api.sherpo.io/merchant/v1/stores/<store>/pages/<page>' \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "slug": "string",
  "title": "string",
  "description": "string",
  "metadata": {
    "property1": true,
    "property2": true
  },
  "menu_position": 1000000,
  "full": true,
  "settings": {
    "storefront": {
      "no_index": true
    },
    "property1": true,
    "property2": true
  }
}
'
```

### TypeScript

```typescript
const url = 'https://api.sherpo.io/merchant/v1/stores/<store>/pages/<page>';
const options = {
  method: 'PATCH',
  headers: {'Content-Type': 'application/json', Authorization: 'Bearer <token>'},
  body: JSON.stringify({
    slug: 'string',
    title: 'string',
    description: 'string',
    metadata: {property1: true, property2: true},
    menu_position: 1000000,
    full: true,
    settings: {storefront: {no_index: true}, property1: true, property2: true}
  })
};

fetch(url, options)
  .then(res => res.json())
  .then(json => console.log(json))
  .catch(err => console.error(err));
```

### Python

```python
import requests

url = "https://api.sherpo.io/merchant/v1/stores/<store>/pages/<page>"

payload = {
    "slug": "string",
    "title": "string",
    "description": "string",
    "metadata": {
        "property1": True,
        "property2": True
    },
    "menu_position": 1000000,
    "full": True,
    "settings": {
        "storefront": { "no_index": True },
        "property1": True,
        "property2": True
    }
}
headers = {
    "Content-Type": "application/json",
    "Authorization": "Bearer <token>"
}

response = requests.patch(url, json=payload, headers=headers)

print(response.text)
```

## Responses

### 200

Updates a custom page's fields.

#### Example

```json
{
  "status": "string",
  "id": "string",
  "slug": "string",
  "title": "string",
  "description": "string",
  "published_at": "string",
  "created_at": "string",
  "updated_at": "string",
  "settings": {
    "storefront": {
      "no_index": true
    },
    "property1": true,
    "property2": true
  },
  "metadata": {
    "property1": true,
    "property2": true
  },
  "menu_position": 0,
  "live": true,
  "path": "string",
  "url": "string",
  "menu_live": true,
  "access": [
    {
      "resource": {
        "kind": "string",
        "id": "string"
      },
      "channel": "string",
      "tier_id": "string",
      "closed": true
    }
  ],
  "attachments": [
    {
      "id": "string",
      "target": {
        "kind": "string",
        "id": "string"
      },
      "role": "string",
      "delivery": "string",
      "preview_only": true,
      "from_body": true,
      "release_file": true,
      "position": 0,
      "asset": {
        "id": "string",
        "locator": "string",
        "origin": "string",
        "custodian": "string",
        "enforcement": "string",
        "mime": "string",
        "bytes": 0,
        "quota_bytes": 0,
        "name": "string",
        "title": "string",
        "ext": "string",
        "status": "string",
        "optimized": true,
        "parent_id": "string",
        "redacted": true,
        "security": "string",
        "description": "string",
        "processed_at": "string",
        "metadata": {
          "width": 0,
          "height": 0,
          "duration": 0,
          "pages": 0,
          "waveform": "string",
          "transcript": {
            "language": "string",
            "confidence": 0
          },
          "arguments": [
            {
              "name": "string",
              "description": "string",
              "required": true,
              "default": "string",
              "match": "string",
              "flags": "string",
              "message": "string",
              "lenient": true
            }
          ],
          "property1": true,
          "property2": true
        },
        "created_at": "string"
      }
    }
  ],
  "files": {
    "property1": {
      "id": "string",
      "kind": "string",
      "mime": "string",
      "name": "string",
      "bytes": 0,
      "width": 0,
      "height": 0,
      "duration": 0,
      "pages": 0,
      "status": "string",
      "url": "string",
      "resized": [
        {
          "width": 1,
          "avif": "string",
          "webp": "string"
        }
      ],
      "attachment_id": "string",
      "unlocks": [
        {
          "product_id": "string",
          "product_name": "string",
          "tier": {
            "id": "string",
            "name": "string",
            "rank": 0
          }
        }
      ],
      "video": {
        "attachment_id": "string",
        "tracks": [
          {
            "id": "string",
            "label": "string",
            "language": "string",
            "generated": true
          }
        ],
        "outputs": [
          "string"
        ]
      },
      "audio": {
        "waveform": "string",
        "attachment_id": "string",
        "tracks": [
          {
            "id": "string",
            "label": "string",
            "language": "string",
            "generated": true
          }
        ],
        "outputs": [
          "string"
        ]
      }
    },
    "property2": {
      "id": "string",
      "kind": "string",
      "mime": "string",
      "name": "string",
      "bytes": 0,
      "width": 0,
      "height": 0,
      "duration": 0,
      "pages": 0,
      "status": "string",
      "url": "string",
      "resized": [
        {
          "width": 1,
          "avif": "string",
          "webp": "string"
        }
      ],
      "attachment_id": "string",
      "unlocks": [
        {
          "product_id": "string",
          "product_name": "string",
          "tier": {
            "id": "string",
            "name": "string",
            "rank": 0
          }
        }
      ],
      "video": {
        "attachment_id": "string",
        "tracks": [
          {
            "id": "string",
            "label": "string",
            "language": "string",
            "generated": true
          }
        ],
        "outputs": [
          "string"
        ]
      },
      "audio": {
        "waveform": "string",
        "attachment_id": "string",
        "tracks": [
          {
            "id": "string",
            "label": "string",
            "language": "string",
            "generated": true
          }
        ],
        "outputs": [
          "string"
        ]
      }
    }
  }
}
```

- `status` (`updatePage.response.200.status`; string, required)
- `id` (`updatePage.response.200.id`; string, required)
- `slug` (`updatePage.response.200.slug`; string, required)
- `title` (`updatePage.response.200.title`; string, required)
- `description` (`updatePage.response.200.description`; any of, required)
  - any of: `string`, `null`
- `published_at` (`updatePage.response.200.published_at`; any of, required)
  - any of: `string`, `null`
- `created_at` (`updatePage.response.200.created_at`; any of, required)
  - any of: `string`, `null`
- `updated_at` (`updatePage.response.200.updated_at`; any of, required)
  - any of: `string`, `null`
- `settings` (`updatePage.response.200.settings`; object, required)
  - `storefront` (`updatePage.response.200.settings.storefront`; object, optional)
    - `no_index` (`updatePage.response.200.settings.storefront.no_index`; boolean, optional)
- `metadata` (`updatePage.response.200.metadata`; map<any of>, required)
- `menu_position` (`updatePage.response.200.menu_position`; any of, required)
  - any of: `number`, `null`
- `live` (`updatePage.response.200.live`; boolean, required) — Served: published and within the pages the plan applies.
- `path` (`updatePage.response.200.path`; string, required) — The storefront path.
- `url` (`updatePage.response.200.url`; any of, required) — The absolute URL on the store's verified hostname, or null before it has one.
  - any of: `string`, `null`
- `menu_live` (`updatePage.response.200.menu_live`; boolean, required) — Shown in the menu: published or scheduled, in it, and within the menu items the plan applies.
- `access` (`updatePage.response.200.access`; array<object>, required)
  - `resource` (`updatePage.response.200.access.resource`; object, required)
    - `kind` (`updatePage.response.200.access.resource.kind`; string, required)
    - `id` (`updatePage.response.200.access.resource.id`; string, required)
  - `channel` (`updatePage.response.200.access.channel`; string, required)
  - `tier_id` (`updatePage.response.200.access.tier_id`; any of, required)
    - any of: `string`, `null`
  - `closed` (`updatePage.response.200.access.closed`; boolean, required)
- `attachments` (`updatePage.response.200.attachments`; array<object>, optional) — Every attachment on the page with its asset whole; answered only with `full`.
  - `id` (`updatePage.response.200.attachments.id`; string, required)
  - `target` (`updatePage.response.200.attachments.target`; object, required)
    - `kind` (`updatePage.response.200.attachments.target.kind`; string, required)
    - `id` (`updatePage.response.200.attachments.target.id`; string, required)
  - `role` (`updatePage.response.200.attachments.role`; string, required)
  - `delivery` (`updatePage.response.200.attachments.delivery`; string, required)
  - `preview_only` (`updatePage.response.200.attachments.preview_only`; boolean, required)
  - `from_body` (`updatePage.response.200.attachments.from_body`; boolean, required)
  - `release_file` (`updatePage.response.200.attachments.release_file`; boolean, required) — A file a software release ships, which its release edits and the product's own list leaves out.
  - `position` (`updatePage.response.200.attachments.position`; number, required)
  - `asset` (`updatePage.response.200.attachments.asset`; object, required)
    - `id` (`updatePage.response.200.attachments.asset.id`; string, required)
    - `locator` (`updatePage.response.200.attachments.asset.locator`; any of, required)
      - any of: `string`, `null`
    - `origin` (`updatePage.response.200.attachments.asset.origin`; string, required)
    - `custodian` (`updatePage.response.200.attachments.asset.custodian`; string, required)
    - `enforcement` (`updatePage.response.200.attachments.asset.enforcement`; string, required)
    - `mime` (`updatePage.response.200.attachments.asset.mime`; any of, required)
      - any of: `string`, `null`
    - `bytes` (`updatePage.response.200.attachments.asset.bytes`; any of, required) — The file's size in bytes; null when it is charged nothing.
      - any of: `number`, `null`
    - `quota_bytes` (`updatePage.response.200.attachments.asset.quota_bytes`; number, required) — The file's size in bytes; zero when it is charged nothing.
    - `name` (`updatePage.response.200.attachments.asset.name`; string, required)
    - `title` (`updatePage.response.200.attachments.asset.title`; any of, required)
      - any of: `string`, `null`
    - `ext` (`updatePage.response.200.attachments.asset.ext`; any of, required)
      - any of: `string`, `null`
    - `status` (`updatePage.response.200.attachments.asset.status`; string, required)
    - `optimized` (`updatePage.response.200.attachments.asset.optimized`; boolean, required)
    - `parent_id` (`updatePage.response.200.attachments.asset.parent_id`; any of, required)
      - any of: `string`, `null`
    - `redacted` (`updatePage.response.200.attachments.asset.redacted`; boolean, required)
    - `security` (`updatePage.response.200.attachments.asset.security`; any of, required)
      - any of: `string`, `null`
    - `description` (`updatePage.response.200.attachments.asset.description`; any of, required)
      - any of: `string`, `null`
    - `processed_at` (`updatePage.response.200.attachments.asset.processed_at`; any of, required)
      - any of: `string`, `null`
    - `metadata` (`updatePage.response.200.attachments.asset.metadata`; object, required)
      - `width` (`updatePage.response.200.attachments.asset.metadata.width`; integer, optional)
        - min 0
      - `height` (`updatePage.response.200.attachments.asset.metadata.height`; integer, optional)
        - min 0
      - `duration` (`updatePage.response.200.attachments.asset.metadata.duration`; number, optional) — Seconds, measured, so rarely whole.
      - `pages` (`updatePage.response.200.attachments.asset.metadata.pages`; integer, optional)
        - min 0
      - `waveform` (`updatePage.response.200.attachments.asset.metadata.waveform`; any of, optional) — An audio file's waveform: 256 levels from 0 to 255, base64; null when it can't be drawn.
        - any of: `string`, `null`
      - `transcript` (`updatePage.response.200.attachments.asset.metadata.transcript`; object, optional)
        - `language` (`updatePage.response.200.attachments.asset.metadata.transcript.language`; string, optional)
        - `confidence` (`updatePage.response.200.attachments.asset.metadata.transcript.confidence`; number, optional)
      - `arguments` (`updatePage.response.200.attachments.asset.metadata.arguments`; array<object>, optional) — What an MCP prompt asks for; only an authored prompt carries it.
        - `name` (`updatePage.response.200.attachments.asset.metadata.arguments.name`; string, required)
        - `description` (`updatePage.response.200.attachments.asset.metadata.arguments.description`; any of, required)
          - any of: `string`, `null`
        - `required` (`updatePage.response.200.attachments.asset.metadata.arguments.required`; boolean, required)
        - `default` (`updatePage.response.200.attachments.asset.metadata.arguments.default`; any of, required)
          - any of: `string`, `null`
        - `match` (`updatePage.response.200.attachments.asset.metadata.arguments.match`; any of, required) — Pattern the whole value must match, diacritic-insensitive.
          - any of: `string`, `null`
        - `flags` (`updatePage.response.200.attachments.asset.metadata.arguments.flags`; any of, required) — Flags among `i`, `s` and `u` the pattern runs with; null for `i` alone.
          - any of: `string`, `null`
        - `message` (`updatePage.response.200.attachments.asset.metadata.arguments.message`; any of, required) — What a refused value is told instead of the default reason.
          - any of: `string`, `null`
        - `lenient` (`updatePage.response.200.attachments.asset.metadata.arguments.lenient`; boolean, required)
    - `created_at` (`updatePage.response.200.attachments.asset.created_at`; any of, required)
      - any of: `string`, `null`
- `files` (`updatePage.response.200.files`; map<object>, optional) — The files its body names; answered only with `full`.

### default

A problem; see https://api.sherpo.io/merchant/docs/errors.

#### Example

```json
{
  "type": "http://example.com",
  "title": "string",
  "status": 0,
  "detail": "string",
  "code": "string",
  "context": {},
  "reached_core": true,
  "core_answer": "string"
}
```

- `type` (`updatePage.response.default.type`; string, required)
  - format `uri`
- `title` (`updatePage.response.default.title`; string, required)
- `status` (`updatePage.response.default.status`; integer, required)
- `detail` (`updatePage.response.default.detail`; string, required)
- `code` (`updatePage.response.default.code`; string, optional)
- `context` (`updatePage.response.default.context`; object, optional)
- `reached_core` (`updatePage.response.default.reached_core`; boolean, optional)
- `core_answer` (`updatePage.response.default.core_answer`; string, optional)


Source: https://docs.sherpo.io/merchant-api/reference/update-page/index.md
