Projects

Update project

Update project metadata and deployment settings. Cannot change type after creation. Provide script.blocks to atomically replace the script in the same call — project must be inactive when script is included.

put/v1/communities/{communityId}/projects/{projectId}

Request

  • Base URL: https://api.subo.ai
  • URL: https://api.subo.ai/v1/communities/{communityId}/projects/{projectId}
  • Auth: API key in header X-API-Key

Path parameters

communityIdstring required

Community ID (Discord guild snowflake, serialized as string)

projectIdstring required

Project ID

Request body

namestring
max_completes_per_userinteger
privacy_mode'transparent' | 'semi-private' | 'anonymous'

Controls response visibility and identity disclosure.

  • transparent — All community members can see exactly who answered what for every question.
  • semi-private — Only the project creator and community admins can view individual responses (who answered what). The rest of the community sees aggregated results only if the creator chooses to share them.
  • anonymous — Respondent identity is hidden from everyone, including the creator and admins. Data is pseudo-anonymous: answers are recorded but not linked to a user ID or display name, unless a respondent volunteers that information in an open-text answer. Caveat: XP and achievements can still be granted in anonymous projects, so participation is not entirely hidden — particularly relevant in small communities.
scoring_enabledboolean nullable

Enable or disable quiz/scoring mode. When true, question blocks may carry correct_answer_index, when_correct, when_incorrect, and per-option score_values. Must be set before writing a script that uses score variables — without it, score_values weights are silently ignored and [score]/[correct_answers] variables render as literal [brackets]. Do not also set rewards.use_xp: true when using an in-survey give_xp action block with a source_key — that combination awards XP twice.

Response

Updated project. Includes data.script.blocks when script was provided.

Changes

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