---
title: "Update report REST API | HitKeep"
description: "Reference for the HitKeep REST API operation Update report, including request parameters, responses, and authentication notes."
canonical: "https://hitkeep.com/api/operations/apireportsreport_id/patch/"
---

# Update report REST API

PATCH

/api/reports/{report_id}

FetchcURL

```
const url = 'http://127.0.0.1:25737/api/reports/2489E9AD-2EE2-8E00-8EC9-32D5F69181C0';
const options = {
  method: 'PATCH',
  headers: {cookie: 'hk_token=<hk_token>', 'Content-Type': 'application/json'},
  body: '{"external_recipient_emails":["hello@example.com"],"name":"example","preset":"site_summary","recipient_user_ids":["2489E9AD-2EE2-8E00-8EC9-32D5F69181C0"],"schedule":{"frequency":"daily","local_time":"example","monthly_day":1,"timezone":"example","weekly_day":1},"site_ids":["2489E9AD-2EE2-8E00-8EC9-32D5F69181C0"],"site_mode":"selected","status":"draft"}'
};

try {
  const response = await fetch(url, options);
  const data = await response.json();
  console.log(data);
} catch (error) {
  console.error(error);
}
```

```
curl --request PATCH \
  --url http://127.0.0.1:25737/api/reports/2489E9AD-2EE2-8E00-8EC9-32D5F69181C0 \
  --header 'Content-Type: application/json' \
  --cookie hk_token=<hk_token> \
  --data '{ "external_recipient_emails": [ "hello@example.com" ], "name": "example", "preset": "site_summary", "recipient_user_ids": [ "2489E9AD-2EE2-8E00-8EC9-32D5F69181C0" ], "schedule": { "frequency": "daily", "local_time": "example", "monthly_day": 1, "timezone": "example", "weekly_day": 1 }, "site_ids": [ "2489E9AD-2EE2-8E00-8EC9-32D5F69181C0" ], "site_mode": "selected", "status": "draft" }'
```

-

Updates an owned personal report or an authorized team report and recalculates its next UTC run.

## Authorizations

- **[cookieAuth](https://hitkeep.com/api/#cookieauth)**

## Parameters

### Path Parameters

**report_id**

required

string format: uuid

Report definition UUID.

## Request Bodyrequired

application/json

object

**external_recipient_emails**

Array<string>

<= 25 items unique items

**name**

string

<= 120 characters

**preset**

string

Allowed values: site_summary portfolio_digest opportunity_brief

**recipient_user_ids**

Array<string>

**schedule**

object

**frequency**

required

string

Allowed values: daily weekly monthly

**local_time**

required

string

/^([01][0-9]|2[0-3]):(00|15|30|45)$/

**monthly_day**

integer

>= 1 <= 28

**timezone**

required

IANA timezone name.

string

**weekly_day**

integer

<= 6

**site_ids**

Array<string>

**site_mode**

string

Allowed values: selected all_accessible

**status**

string

Allowed values: draft active paused

## Responses

### 200

Updated report

application/json

object

**consent_version**

integer

>= 1

**created_at**

required

string format: date-time

**created_by**

string format: uuid

**id**

required

string format: uuid

**last_outcome**

object

***key***

additional properties

any

**name**

required

string

**next_run_at**

string format: date-time

**owner_user_id**

string format: uuid

**preset**

required

string

Allowed values: site_summary portfolio_digest opportunity_brief

**recipients**

required

Array<object>

object

**confirmation_expires_at**

string format: date-time

**confirmed_at**

string format: date-time

**email**

required

string format: email

**id**

required

string format: uuid

**invitation_state**

string

Allowed values: pending sent failed

**kind**

required

string

Allowed values: member external

**opted_out_at**

string format: date-time

**status**

required

string

Allowed values: pending_confirmation confirmed opted_out

**user_id**

string format: uuid

**schedule**

required

object

**frequency**

required

string

Allowed values: daily weekly monthly

**local_time**

required

string

/^([01][0-9]|2[0-3]):(00|15|30|45)$/

**monthly_day**

integer

>= 1 <= 28

**timezone**

required

IANA timezone name.

string

**weekly_day**

integer

<= 6

**scope**

required

string

Allowed values: personal team

**site_mode**

required

string

Allowed values: selected all_accessible

**sites**

required

Array<object>

object

**domain**

string

**id**

string format: uuid

**source**

required

string

Allowed values: v2 legacy

**status**

required

string

Allowed values: draft active paused

**tenant_id**

string format: uuid

**updated_at**

required

string format: date-time

##### Example

```
{
  "preset": "site_summary",
  "recipients": [
    {
      "invitation_state": "pending",
      "kind": "member",
      "status": "pending_confirmation"
    }
  ],
  "schedule": {
    "frequency": "daily"
  },
  "scope": "personal",
  "site_mode": "selected",
  "source": "v2",
  "status": "draft"
}
```

### 400

Invalid report

application/json

object

**message**

string

##### Examplegenerated

```
{
  "message": "example"
}
```

### 409

Mail unavailable

application/json

object

**message**

string

##### Examplegenerated

```
{
  "message": "example"
}
```

[Previous Delete report](https://hitkeep.com/api/operations/apireportsreport_id/delete/)[Next Resend external recipient confirmation](https://hitkeep.com/api/operations/apireportsreport_idrecipientsrecipient_idconfirmation/)