Projects

Open project

Activate the project for participant responses now. Project must be inactive. To open it later instead, set a scheduled delivery.opening with the update endpoint and do not call this one: the project opens itself at that time.

Optionally pass a delivery body to override audience, closing time, or invitation settings at the moment of opening — without a separate PUT call. All fields are optional.

The invitation is posted only where the project names a place, and today that place is a Discord channel, delivery.invitation.post_channel_id. A project answered on the web (open_web, or private with response_channel web) with no channel opens without posting anything: the response carries data.share_url for you to share and a notice. A project answered in Discord needs the channel and returns 422 channel_required without one.

Go-live validation runs first, as in the Subo app: script errors block the call, and so do warnings the project has not accepted (409 script_validation, listing each finding). Accept a warning by passing its fingerprint in acknowledge; errors cannot be accepted and must be fixed. Run validate first to see them before the audience would.

post/v1/communities/{communityId}/projects/{projectId}/open

Request

  • Base URL: https://api.subo.ai
  • URL: https://api.subo.ai/v1/communities/{communityId}/projects/{projectId}/open
  • 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

acknowledgestring[]

Fingerprints of script-validation warnings to accept for this project (from the validate endpoint or a 409 script_validation). Recorded as accepted by the key's user, as in the Subo app. Errors have no fingerprint and cannot be accepted.

Response

Project activated. data.share_url is the respondents' web link (null for a project answered in Discord). A top-level notice is included when no invitation was posted.

Changes

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