Skip to main content
PATCH

Authorizations

X-API-Key
string
header
required

Organization API key for authentication

Headers

X-Coval-Workspace-Id
string

Workspace that scopes this operation. When omitted, the organization's active default workspace is used when one can be resolved.

Required string length: 1 - 26

Path Parameters

project_id
string
required

The project ID (ULID)

Body

application/json
assignee_user_ids
string[] | null

Verified Coval reviewer User IDs, mutually exclusive with emails. Null leaves membership unchanged.

Required array length: 1 - 1000 elements
Required string length: 26
opted_out_assignee_user_ids
string[] | null

Assigned reviewer IDs opting out of notifications, mutually exclusive with email opt-outs. Null leaves preferences unchanged; an empty list clears them. Authenticated users may change only their own preference.

Maximum array length: 1000
Required string length: 26
display_name
string | null

Updated project name

Required string length: 1 - 200
description
string | null

Updated description

assignees
string[] | null

Updated assignee list

linked_simulation_ids
string[] | null

Updated simulation IDs

add_linked_simulation_ids
string[] | null

Simulation IDs to add atomically; cannot be combined with other project updates

Minimum array length: 1
remove_linked_simulation_ids
string[] | null

Simulation IDs to remove atomically; cannot be combined with other project updates

Minimum array length: 1
linked_metric_ids
string[] | null

Updated metric IDs

Maximum array length: 25
metric_addition_completion_action
enum<string> | null

Required only when adding metrics to choose whether valid enforced-collaborative completed conversations reopen; omitted keeps completed conversations unchanged

Available options:
KEEP_COMPLETED,
REOPEN_COMPLETED
notifications
boolean | null

Updated notification setting

project_rules
enum<string>[] | null

Updated project rules

Project rule: require_disagreement_notes requires reviewer notes when ground truth disagrees with model output

Available options:
require_disagreement_notes
blind_labeling_shown_metric_ids
string[] | null

Metric IDs whose machine score stays visible during blind labeling

opted_out_assignees
string[] | null

Assignees who opted out of notifications

enforced_collaboration
boolean
default:false

Enforce claims and explicit single-author completion for collaborative projects

allow_metric_skipping
boolean
default:false

Allow reviewers to skip linked metrics

project_type
string | null
review_label_enabled
boolean | null

False pauses conversation triage for everyone while preserving categories, modes, and saved labels. True enables triage. Null uses legacy configuration-based activation. Omission leaves the enabled state unchanged. For legacy clients, explicitly sending empty categories and both modes as null without this field pauses triage while preserving configuration. When all three configuration fields are supplied without this field, a valid enabled configuration is treated as enabled.

review_label_input_mode
enum<string> | null
Available options:
OPTION_ONLY,
CUSTOM_ONLY,
OPTION_OR_CUSTOM
review_label_options
string[] | null
review_label_selection_mode
enum<string> | null
Available options:
SINGLE,
MULTIPLE

Response

Project updated successfully

review_project
object
required

A single review project resource.