Skip to main content

Update Site Metadata

Update a site’s metadata without publishing a new version. Use this to change the title, description, add password protection, or set an expiry.

Path Parameters

string
required
The site slug (e.g., bright-canvas-a7k2).

Headers

Request Body

All fields are optional. Only include the fields you want to change. Set a field to null to clear it.
string | null
Page title shown in browser tab and social previews.
string | null
Meta description for social previews.
string | null
Path to an existing file in the site to use as the Open Graph image.
string | null
Set a password to protect the site. Set to null to remove protection. Passwords are hashed server-side.
number | null
Set an expiry in seconds from now. Set to null to make permanent.

Example

Response (200)