site-controller

Update a site's editable metadata

patch/api/sites/{slug}

Request

  • Base URL: https://api.pagegoat.com
  • URL: https://api.pagegoat.com/api/sites/{slug}
  • Auth: HTTP bearer

Path parameters

slugstring required

Request body

namestring nullable

New display name.

slugstring nullable

New slug. Rejected if taken or malformed.

commentsEnabledboolean nullable

Allow new comments.

hiddenFromSearchboolean nullable

Emit noindex on the viewer page. Advisory, not access control.

projectIdstring uuid nullable

Project to file this site under. Send null to unfile it; omit the field entirely to leave it where it is.

Example request

{
  "name": "My First Project",
  "slug": "my-first-project"
}

Response

OK

Changes

No recorded changes to this operation across all 1 revision of this API.