Version
DESTRUCTIVE

update_project

Apply a partial update to a project. Only supplied fields are touched; omitted keys stay as-is.

Apply a partial update to an existing project. Delegates to an Action so the project-service policy and cache invalidation run, and a project.updated event fires with a map of changed fields.

A new handle moves the portal URL at once, on every tier; every address the project answered on before keeps redirecting to the current one, and a handle another project has, or used to have, is refused as taken. A blank handle switches the portal page off.

storefront_arrangement chooses how the portal, the embed and the bot order the plans on offer: manual is the order pinned through reorder_plans, with passes, seasons and then subscriptions behind anything unpinned; live puts the passes and seasons whose access is on now first, the one ending soonest at the top, then those opening soonest, then the pinned order. live needs the project owner's time-limited passes capability (Growth, or the Passes Addon); when it lapses the storefronts fall back to the pinned order at once and the stored value is reset to manual with a project.updated event.

Requires ability

The token behind the MCP session must hold it, or the call is refused with TOKEN_MISSING_ABILITY.

Runs the same action as

The REST endpoint and this tool share one action, so validation, permissions and events are identical.

Fires one event

Delivered to every endpoint subscribed to it once the change is made.

Annotations

DestructiveIdempotentOpen world

A client that honours annotations asks a person before running it. Sending the same arguments twice changes nothing the second time. It reaches beyond Subscriby: a connector, a provider or a member.

Arguments

project_id*string

UUID of the project to update.

namestringoptional

New project name (min 5, max 255 chars).

descriptionstringoptional

New description. Max 1000 chars, HTML is filtered.

handlestringoptional

New URL-friendly handle, on every tier. Alpha-dash lowercase, 5-255 chars, unique across every project's current and former handles; the old address keeps redirecting.

termsstringoptional

URL to the terms page. Max 255 chars.

privacystringoptional

URL to the privacy page. Max 255 chars.

storefront_arrangementstringoptional

How the portal, the embed and the bot order the plans on offer: "manual" is the order pinned through `reorder_plans` with passes, seasons and then subscriptions behind it; "live" puts the passes and seasons whose access is on now first, the one ending soonest at the top, then those opening soonest, then the pinned order. "live" needs the project owner's time-limited passes capability (Growth, or the Passes Addon) and is refused with `TEAM_TIER_REQUIRED` without it; "manual" is always accepted.

manuallive
activebooleanoptional

Flip to false to archive, true to restore.

outage_compensationsbooleanoptional

Whether members whose paid access overlapped a connector outage of an hour or more have it extended by the outage length when the connector answers again. Defaults to true on every project.

hide_brandingbooleanoptional

Take the "Powered by Subscriby" mark off the portal page, its social card and the bot (true) or put it back (false). Off by default on every plan; true needs a Starter or Growth tier (TEAM_TIER_REQUIRED otherwise), and a project whose owner lost the tier keeps the switch and shows the mark until the plan returns.

team_idstringoptional

UUID of the owning team.

What it returns

{  "data": {    "id": "7f3d1c92-8b45-4e6a-9d21-5c8e0a4b6f13",    "name": "Research Premium",    "handle": "research-premium",    "active": true  }}

How it fails

RESOURCE_NOT_FOUND

unknown project_id, or the project belongs to a team outside the token's scope.

VALIDATION_FAILED

a malformed field, a storefront_arrangement that is neither manual nor live, or team_id is a team the token's owner does not belong to.

TEAM_TIER_REQUIRED

storefront_arrangement set to live while the project owner's plan and addons do not include time-limited passes.

TOKEN_MISSING_ABILITY

token lacks project:update.

How is this guide?

Last updated on