Skip to content
HeyX API

Update Problem Status

Required scope: problem:update

Perform a coarse lifecycle transition on a problem. Set one or more of resolve, close, and archive; at least one must be present. This is separate from the everyday field edit performed by Update Problem. The API key creator must currently be authorized for the target problem.

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

Applies coarse lifecycle transitions (resolve, close, archive) that UpdateProblem deliberately excludes. Resolution may be blocked when the problem has incomplete tasks or manual solving is disabled.

Request UpdateProblemStatusRequest
Response UpdateProblemStatusResponse

UpdateProblemStatusRequest

Field Type Description
id string Identifies the target problem. Must be visible to the API key actor.
resolve optional bool When true, resolves the problem if it is open. Blocked by incomplete tasks or when manual solving is disabled for the problem.
close optional bool When true, closes the problem if it is open.
archive optional bool Sets the archived state to this value.

UpdateProblemStatusResponse

Field Type Description
problem Problem The problem after applying the requested transitions.

Related Types

Problem

Field Type
id string
title string
description string
status ProblemStatus
severity int32
customer_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

ProblemLabel

Field Type
id optional string
name string
color_hex string

Request

Section titled “Request”
{
  "id": "<problem-id>",
  "resolve": true
}

Response

Section titled “Response”
{
  "problem": {
    "id": "<problem-id>",
    "title": "Inspection follow-up",
    "status": "resolved"
  }
}

The response contains the updated problem in the same shape returned by Get Problem. This is not idempotent; do not blindly retry a timed-out call.

HeyX API