---
title: "Edit page or site metadata"
method: PATCH
path: "/websiteSourceCode/metadata"
tags: ["Source code"]
---

# Edit page or site metadata

`PATCH /websiteSourceCode/metadata`

## Request

- Base URL: `https://api.cactal.ai/v1`
- URL: `https://api.cactal.ai/v1/websiteSourceCode/metadata`
- Auth: HTTP bearer

Replaces a page's complete metadata object when `page` is sent, otherwise the site defaults in `website_config`. Takes the edit lease when no `leaseToken` is sent.

## Request body

- object
  - `websiteId` string, required
  - `page` string: Page to edit. Omit to edit the site-wide default metadata in `website_config`.
  - `metadata` unknown, required
  - `leaseToken` string: Omit to have Cactal take the edit lease for you; pass a token from websiteSourceCode.lease.acquire to take over from another editor.

## Response `200`

The committed edit and the effective metadata.

- object
  - `version` integer, required: Head version after the edit: the previous head plus one, or the unchanged head when `changed` is `false`.
  - `changed` boolean, required: `false` when the edit was a no-op and no new version was created.
  - `metadata` unknown, required
  - `metadataChanged` boolean, required: Whether the metadata differs from its previous value.

## Other responses

- `400`: Validation failed. The response `message` names the first invalid field.
- `401`: Missing, invalid, expired, or revoked API key.
- `403`: The authenticated principal lacks the required capability.
- `404`: The resource does not exist or is outside the principal’s access scope.
- `409`: The request conflicts with the current state of the resource.
- `429`: Rate limit exceeded. Retry after the number of seconds in the `Retry-After` header.

---

[API](https://skmtc.dev/cactal/apis/cactal-api.md) · [All operations](https://skmtc.dev/cactal/apis/cactal-api/llms.txt) · [OpenAPI document](https://skmtc.dev/cactal/apis/cactal-api/revisions/9cd0fb5eacdd?raw)