Update Report

With the Report endpoints you can get and update some information about bug reports.

Endpoints

Updates a report object

PATCH https://api.bugpilot.io/v1/reports/[reportId]

This Endpoint can be used to update some report fields. The endpoint accepts a JSON body.

Path Parameters

Name	Type	Description
reportId*	String	The ID of the Bugpilot Report you want to change

Headers

Name	Type	Description
Content-Type*	String	application/json

Request Body

Name	Type	Description
metadata.userProvidedDescription	String	Updates a description for a bug report.

200: OK If the report has been updated. The updated report JSON is included in the response.

{
    // Response
}

Example Request Body

Update a user-provided description for a bug. A user-provided description is shown in the description area of a bug report (as shown in the screenshot below).

{"metadata":{"userProvidedDescription":"new description for the bug"}}