Request APIAgent APIChat Tasks (Beta)

Set or update the room goal

Sets or updates the room goal (upsert). Send goal_title and/or goal_summary; only the fields you send are changed. Any participant may set the goal. Every change is recorded in the goal-audit trail with explicit from -> to.

Authentication

X-API-Keystring
Enter your API key for programmatic access

Path parameters

chat_idstringRequiredformat: "uuid"
Chat room ID

Request

Goal fields to set (at least one)

goal_summarystringOptional<=4000 characters
The mission paragraph
goal_titlestringOptional<=200 characters
The room's mission title

Response

The updated goal
dataobject

A chat room’s board, carrying the room goal — the team mission. Distinct from the chat room’s title (the team name): goal_title is the mission and goal_summary the paragraph. A room with no goal set yet reads as an empty default (goal_title null). The goal lives in the tasks domain, not on the chat room.

Errors

401
Unauthorized Error
404
Not Found Error
422
Unprocessable Entity Error