> 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

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

## 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="https://2608956386-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FfPAk6CyomZOa3coMGHaI%2Fuploads%2FTDsEOJZXqoDU22ZrBGWx%2Fimage.png?alt=media&amp;token=a8a202d9-c575-462b-ba22-2d0e5ecb2a53" alt=""><figcaption></figcaption></figure>