Skip to main content
PATCH
Set the user-facing status of a brief

Authorizations

Authorization
string
header
required

Path Parameters

organization_id
string<uuid>
required

Organization identifier

result_id
string<uuid>
required

Recommended action result identifier

task_id
string<uuid>
required

Task identifier

workspace_id
string<uuid>
required

Workspace identifier

Body

status
enum<string>

New status for the brief. One of: not_started, in_progress, implemented

  • not_started - not_started
  • in_progress - in_progress
  • implemented - implemented
Available options:
not_started,
in_progress,
implemented

Response

Brief status updated

id
string<uuid>
required

Brief UUID

task_id
string<uuid>
required

Task UUID this brief belongs to

title
string
required

Brief title

body
string
required

Brief body content

is_user_edited
boolean
required

True once a user has edited title or body

status
enum<string>
required

User-facing status. One of: not_started, in_progress, implemented

  • not_started - not_started
  • in_progress - in_progress
  • implemented - implemented
Available options:
not_started,
in_progress,
implemented
created_at
string<date-time> | null

Creation timestamp

updated_at
string<date-time> | null

Last update timestamp