- [HTTP request](https://docs.cloud.google.com/chronicle/docs/reference/rest/v1beta/projects.locations.instances.cases.caseWallRecords/favorite#body.HTTP_TEMPLATE)
- [Path parameters](https://docs.cloud.google.com/chronicle/docs/reference/rest/v1beta/projects.locations.instances.cases.caseWallRecords/favorite#body.PATH_PARAMETERS)
- [Query parameters](https://docs.cloud.google.com/chronicle/docs/reference/rest/v1beta/projects.locations.instances.cases.caseWallRecords/favorite#body.QUERY_PARAMETERS)
- [Request body](https://docs.cloud.google.com/chronicle/docs/reference/rest/v1beta/projects.locations.instances.cases.caseWallRecords/favorite#body.request_body)
- [Response body](https://docs.cloud.google.com/chronicle/docs/reference/rest/v1beta/projects.locations.instances.cases.caseWallRecords/favorite#body.response_body)
- [Authorization scopes](https://docs.cloud.google.com/chronicle/docs/reference/rest/v1beta/projects.locations.instances.cases.caseWallRecords/favorite#body.aspect)
- [IAM Permissions](https://docs.cloud.google.com/chronicle/docs/reference/rest/v1beta/projects.locations.instances.cases.caseWallRecords/favorite#body.aspect_1)
- [FavoriteRequest](https://docs.cloud.google.com/chronicle/docs/reference/rest/v1beta/projects.locations.instances.cases.caseWallRecords/favorite#FavoriteRequest)
  - [JSON representation](https://docs.cloud.google.com/chronicle/docs/reference/rest/v1beta/projects.locations.instances.cases.caseWallRecords/favorite#FavoriteRequest.SCHEMA_REPRESENTATION)

**Full name**: projects.locations.instances.cases.caseWallRecords.favorite

Sets or unsets (toggles) the favorite status of a wall record. Use this method to highlight or unhighlight key pieces of evidence or critical observations on the case wall.

### HTTP request

`PATCH https://{endpoint}/v1beta/{favoriteRequest.name}:favorite`

Where `{endpoint}` is one of the [supported service endpoints](https://docs.cloud.google.com/chronicle/docs/reference/rest#rest_endpoints).

### Path parameters

| Parameters ||
|---|---|
| `favoriteRequest.name` | `string` Required. The resource name of the CaseWallRecords to retrieve. Format: projects/{project}/locations/{location}/instances/{instance}/cases/{case}/caseWallRecords/{caseActivity} |

### Query parameters

| Parameters ||
|---|---|
| `updateMask` | ``string (`https://protobuf.dev/reference/protobuf/google.protobuf#field-mask` format)`` Optional. The list of fields to update. If not included, all fields with default/non-default values will be overwritten. This is a comma-separated list of fully qualified names of fields. Example: `"user.displayName,photo"`. |

### Request body

The request body contains an instance of `https://docs.cloud.google.com/chronicle/docs/reference/rest/v1beta/projects.locations.instances.cases.caseWallRecords/favorite#FavoriteRequest`.

### Response body

If successful, the response body contains an instance of `https://docs.cloud.google.com/chronicle/docs/reference/rest/v1beta/projects.locations.instances.cases.caseWallRecords#CaseWallRecord`.

### Authorization scopes

Requires one of the following OAuth scopes:

- `https://www.googleapis.com/auth/cloud-platform`
- `
  https://www.googleapis.com/auth/chronicle`

For more information, see the [Authentication Overview](https://docs.cloud.google.com/docs/authentication#authorization-gcp).

### IAM Permissions

Requires the following [IAM](https://cloud.google.com/iam/docs) permission on the `name` resource:

- `chronicle.caseWallRecords.update`

For more information, see the [IAM documentation](https://cloud.google.com/iam/docs).

## FavoriteRequest

Request message for caseWallRecords.favorite request.

| JSON representation |
|---|
| ``` { "name": string, "recordId": string, "activityType": enum (`https://docs.cloud.google.com/chronicle/docs/reference/rest/v1beta/projects.locations.instances.cases.caseWallRecords#WallActivityType`), "activityKind": enum (`https://docs.cloud.google.com/chronicle/docs/reference/rest/v1beta/projects.locations.instances.cases.caseWallRecords#ActivityKind`), "favorite": boolean } ``` |

| Fields ||
|---|---|
| `name` | `string` Required. The resource name of the CaseWallRecords to retrieve. Format: projects/{project}/locations/{location}/instances/{instance}/cases/{case}/caseWallRecords/{caseActivity} |
| `recordId` | `string (https://developers.google.com/discovery/v1/type-format format)` Required. The ID of the wall record to set as a favorite. |
| `activityType` | ``enum (`https://docs.cloud.google.com/chronicle/docs/reference/rest/v1beta/projects.locations.instances.cases.caseWallRecords#WallActivityType`)`` Required. The type of the activity. |
| `activityKind` | ``enum (`https://docs.cloud.google.com/chronicle/docs/reference/rest/v1beta/projects.locations.instances.cases.caseWallRecords#ActivityKind`)`` Optional. The kind of the activity. |
| `favorite` | `boolean` Required. Whether the activity is was marked as favorite. |