> For the complete documentation index, see [llms.txt](https://bugpilot.gitbook.io/api-docs/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://bugpilot.gitbook.io/api-docs/http-api/api-reference/update-report.md).

# Update Report

## Endpoints

## Updates a report object

<mark style="color:purple;">`PATCH`</mark> `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<mark style="color:red;">\*</mark> | String | The ID of the Bugpilot Report you want to change |

#### Headers

| Name                                           | Type   | Description        |
| ---------------------------------------------- | ------ | ------------------ |
| Content-Type<mark style="color:red;">\*</mark> | String | `application/json` |

#### Request Body

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

{% tabs %}
{% tab title="200: OK If the report has been updated. The updated report JSON is included in the response." %}

```javascript
{
    // Response
}
```

{% endtab %}
{% endtabs %}

### 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).

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

<figure><img src="/files/JorUyfJKYAqxqgu2EZwl" alt=""><figcaption></figcaption></figure>


---

# Agent Instructions
This documentation is published with GitBook. GitBook is the documentation platform designed so that both humans and AI agents can read, navigate, and reason over technical content effectively. Learn more at gitbook.com.

## Querying This Documentation
If you need additional information that is not directly available in this page, you can query the documentation dynamically by asking a question.

Perform an HTTP GET request on the current page URL with the `ask` query parameter, and the optional `goal` query parameter:

```
GET https://bugpilot.gitbook.io/api-docs/http-api/api-reference/update-report.md?ask=<question>&goal=<endgoal>
```

`ask` is the immediate question: it should be specific, self-contained, and written in natural language.
`goal` is optional and describes the broader end goal you are ultimately trying to accomplish on behalf of the user. GitBook uses it to tailor the answer towards what is most useful for that goal.

The response will contain a direct answer to the question and relevant excerpts and sources from the documentation.

Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.