Problems API - POST close a problem

Closes the specified problem and adds the closing comment.

The request consumes and produces an application/json payload.

Early Adopter

This request is an Early Adopter release and may be changed in non-compatible way.

  • Managed https://{your-domain}/e/{your-environment-id}/api/v2/problems/{problemId}/close
  • SaaS https://{your-environment-id}{problemId}/close
  • Environment ActiveGate https://{your-activegate-domain}/e/{your-environment-id}/api/v2/problems/{problemId}/close


To execute this request, you need the Write problems (problems.write) permission assigned to your API token. To learn how to obtain and use it, see Tokens and authentication.


Parameter Type Description In Required
problemId string

The ID of the required problem.

path required
body ClosingComment

The JSON body of the request. Contains the closing comment on the problem.

body optional

Body format

The ClosingComment object

The closing comment on a problem.

Element Type Description Required
message string

The text of the closing comment.



Response codes

Code Description



The problem is closed already the request hasn't been executed.

Response body

The ProblemCloseResult object

The result of closing a problem.

Element Type Description
problemId string

The ID of the problem.

closeTimestamp integer

The timestamp when the user triggered the closing.

closing boolean

True, if the problem is being closed.

comment Comment

The Comment object

The comment to a problem.

Element Type Description
createdAtTimestamp integer

The timestamp of comment creation, in UTC milliseconds.

authorName string

The user who wrote the comment.

context string

The context of the comment.

id string

The ID of the comment.

content string

The text of the comment.