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
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*stringUUID of the project to update.
namestringoptionalNew project name (min 5, max 255 chars).
descriptionstringoptionalNew description. Max 1000 chars, HTML is filtered.
handlestringoptionalNew 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.
termsstringoptionalURL to the terms page. Max 255 chars.
privacystringoptionalURL to the privacy page. Max 255 chars.
storefront_arrangementstringoptionalHow 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.
manualliveactivebooleanoptionalFlip to false to archive, true to restore.
outage_compensationsbooleanoptionalWhether 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_brandingbooleanoptionalTake 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_idstringoptionalUUID 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_FOUNDunknown project_id, or the project belongs to a team outside the token's scope.
VALIDATION_FAILEDa 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_REQUIREDstorefront_arrangement set to live while the project owner's plan and addons do not include time-limited passes.
TOKEN_MISSING_ABILITYtoken lacks project:update.
How is this guide?
Last updated on
update_portal_design
Change some keys of a project's portal design in its draft; anything omitted keeps its drafted value and members keep seeing the published design.
Recovery Sequences Tools
A recovery sequence is the ordered set of messages a member receives on the days the creator chose after one of four moments, a member who left, a new lead, a checkout that stalled or a trial without a card about to end, each with the way to the plan as a button and, optionally, a coupon; a member enrols once per firing, never while they hold what the trigger counts as a conversion, and leaves the sequence the moment a charge settles for them, a member won back on the churn trigger and a conversion on the others.