Skip to content
HeyX API

Update Problem

Required scope: problem:update

This bounded update can change the title, description, severity, assignees, and labels. It does not resolve, close, archive, or otherwise transition a problem. The API key creator must currently be authorized for the target problem.

Generated Reference
POST /public-api/publicapi.v1.Problem/UpdateProblem

Updates supported everyday fields without performing lifecycle transitions.

Request UpdateProblemRequest
Response UpdateProblemResponse

UpdateProblemRequest

Field Type
id string
title optional string
description optional string
severity optional int32
add_assignee_ids repeated string
remove_assignee_ids repeated string
add_labels repeated ProblemLabel
remove_label_ids repeated string

UpdateProblemResponse

Field Type
problem Problem

Related Types

ProblemLabel

Field Type
id optional string
name string
color_hex string

Problem

Field Type
id string
title string
description string
status ProblemStatus
severity int32
portfolio_id optional string
problem_template_id optional string
problem_template_name string
assignees repeated ProblemAssignee
labels repeated ProblemLabel
resolved_at optional int64
closed_at optional int64
archived_at optional int64
created_at int64
updated_at int64
total_tasks int32
completed_tasks int32

ProblemAssignee

Field Type
id string
display_name string
kind string

Request

Section titled “Request”
{
  "id": "<problem-id>",
  "title": "Inspection follow-up",
  "severity": 3,
  "addAssigneeIds": ["<member-or-team-id>"],
  "removeLabelIds": ["<label-id>"]
}

Only supplied scalar fields and requested assignment or label changes are applied. Do not blindly retry a timed-out mutation; it may still complete.

HeyX API