Octri API
PATCH/api/v1/projects/{projectId}

Update a project

Updates a project's name and documentation site settings. Send only the fields you want to change; name must be 1–120 characters, and theme, seo, and socials configure the published docs site. Theme, SEO, and social changes go live on the published docs site as soon as you save them.

  • IdempotentThe SDK sends Idempotency-Key, so a retried request is only applied once.

1 parameter · 8 body fields
projectIdstringrequired

The project's ID, obtained from listProjects, identifying the project to update.

Partial project settings update. Send only the fields you want to change; no individual body fields are required.

feedbackEnabledbooleanoptional

Show the page feedback widget.

githubEndpointSyncbooleanoptional

Write endpoint changes back to the spec's GitHub repository.

landingPageSlugstringoptional

The slug of the page served at the root of the docs site.

namestringoptional

The project name. Must be 1–120 characters.

seoobjectoptional

SEO settings for the docs site.

socialsobjectoptional

Social links by platform. A platform left out is unchanged, and "" removes it.

themeobjectoptional

Visual theme settings for the docs site.

webMcpEnabledbooleanoptional

Expose the docs site's tools to browser agents through WebMCP.

4 status codes
200Returns an object containing the updated project, including its ID, name, slug, status, and docs subdomain; the project may also include other settings.
projectobjectrequired

The stored project. It also carries settings not listed here.

400Returned when the request fails validation.
errorobjectrequired
401Returned when the API key is missing or invalid.
errorobjectrequired
404Returned when the project or resource does not exist in this organisation.
errorobjectrequired

Error handling

A 400 is returned when a supplied value fails validation. A 401 is returned when the API key is missing or invalid, and a 404 is returned when the project or resource does not exist in this organisation. The projectId path parameter must identify a project in the authenticated user's organisation; landingPageSlug must not exceed 200 characters, socials.custom accepts at most 5 links with label and url, and enum fields must use one of the values listed in the request schema.