Skip to main content
PATCH
Rename a website

Authorizations

Authorization
string
header
required

Cactal API key. Create one in the dashboard or via POST /apiKeys. The plaintext key is shown once at creation.

Path Parameters

websiteId
string
required
Minimum string length: 1

Body

application/json
name
string
required
Required string length: 1 - 200
slug
string

Response

The renamed website.

id
string
required

Unique website id.

organizationId
string
required

Id of the organization that owns the website.

name
string
required

Display name, 1–200 characters.

slug
string
required

URL-safe identifier unique among active websites in the organization.

customDomainsEnabled
boolean
required

Whether custom domains are enabled. Enabling is owner-only and makes the website a billable site; custom domains can only be attached while true.

headVersion
integer
required

Latest draft source version number; starts at 1.

publishedVersion
integer | null
required

Currently published version. null when the website is not published.

createdAt
string<date-time>
required

When the website was created.

updatedAt
string<date-time>
required

When the website was last modified.