update_session
Edit existing session metadata – goal, topic, facilitation prompt, pre-session questions, and result visibility – to keep deliberation sessions aligned with current needs.
Instructions
Update session metadata. Mirrors the v1 PATCH /api/v1/sessions/[id] ALLOWED_UPDATE_FIELDS surface. Requires editor role.
Input Schema
| Name | Required | Description | Default |
|---|---|---|---|
| goal | No | Updated session goal | |
| topic | No | Updated session topic | |
| prompt | No | Updated custom facilitation prompt | |
| context | No | Updated background context | |
| critical | No | Updated critical question or constraint | |
| questions | No | Pre-session questions. Replaces the existing pre-survey wholesale. | |
| project_id | No | Move the session into a project (workspace) by id, or pass `null` to detach it from all projects. Requires editor access to the target project. Attaching does not remove the session from any OTHER project it belongs to. | |
| session_id | Yes | Session ID (UUID) | |
| template_id | No | Template id that backs this session. Editing without recomposing the prompt (POST /sessions/[id]/regenerate-facilitation-prompt) leaves prompt + template out of sync. Pass `null` to detach. | |
| distribution | No | Distribution targets for channel integrations | |
| prompt_summary | No | Short summary of the facilitation prompt (HAR-859). Usually written together with `prompt` by the regenerate-facilitation-prompt flow; setting manually outside that flow can confuse the Brief-drift banner. | |
| summary_prompt | No | Updated custom summarization prompt | |
| intro_video_url | No | Optional intro video URL embedded on the session landing page. Pass `null` to clear. | |
| welcome_message | No | Markdown welcome message shown on the session landing page before participants enter chat. | |
| widgets_enabled | No | Enable AI-emitted Polls and ratings widgets (SingleSelect, MultiSelect, RatingScale, RankingList). Default false. | |
| meta_description | No | Session-specific OG meta description for landing-page link previews. | |
| cross_pollination | No | Enable/disable idea sharing between participant threads | |
| results_visibility | No | Who can see aggregated results. "host" = owner only; "participants" = anyone who completed; "public" = anyone with the URL. | |
| prompt_generated_from | No | Snapshot of the Brief fields that produced the current `prompt` (HAR-859). Brief-drift detection compares this against current topic/goal/critical/context. | |
| platform_guidelines_override | No | Per-session override of the Platform Guidelines block in the facilitation prompt (HAR-868). Pass `null` to fall back to the platform default. |