---
title: "ClientFavorites.update"
method: PATCH
path: "/entities/ClientFavorites/{id}"
tags: ["Client"]
---

# ClientFavorites.update

`PATCH /entities/ClientFavorites/{id}`

Modifies ClientFavorite or ClientFavorites with given id(s)

## Path parameters

- `id` string, uuid, required

## Query parameters

- `validation-level` integer

## Request body

- UpdateClientFavoriteInput
  - `account_id` string, uuid — Id of the favorite account.
  - `activity_id` string, uuid — Id of the favorite appointment or task, or empty when not pointing to an activity.
  - `contact_id` string, uuid — Id of the favorite contact.
  - `custom_entity_id` string, uuid — Id of the favorite custom entity record.
  - `email_id` string, uuid — Id of the favorite email.
  - `lead_oppty_id` string, uuid — Id of the favorite lead or opportunity, or empty when not pointing to one.
  - `owner_id` string, uuid — Id of the owning user.
  - `profile_id` string, uuid — Id of the favorite screen profile.
  - `project_id` string, uuid — Id of the favorite project.
  - `quote_id` string, uuid — Id of the favorite quote.
  - `report_id` string, uuid — Id of the favorite report.
  - `revision` integer — Revision when entity was lastly changed.

## Response `200`

Modification confirmation. Returns resulting ClientFavorite

- object
  - `success` boolean — True when response succeeded, false on error.
  - `data` ClientFavorite
    - `is_delete_protected` boolean, required — Tells if the entity instance is protected against delete (Entities that need to be present in the system at any time). Delete action still may fail if entity is deletable, due some other additional validations.
    - `id` string, uuid, required — Unique identifier of entity.
    - `is_deleted` boolean — Specifies if the entity is considered deleted.
    - `modified` string, date-time — Last modification time.
    - `created` string, date-time — Creation time.
    - `account` string, uri — Account marked as favorite, when this favorite points to an account. Relation to Account. By default it is returned as URI to related resource. Using parameter 'expand', it will return full entity. See: 'Account' object for properties.
    - `appointment` string, uri — Appointment marked as favorite. Set when activity_id resolves to an Appointment. Relation to Appointment. By default it is returned as URI to related resource. Using parameter 'expand', it will return full entity. See: 'Appointment' object for properties.
    - `task` string, uri — Task marked as favorite. Set when activity_id resolves to a Task. Relation to Task. By default it is returned as URI to related resource. Using parameter 'expand', it will return full entity. See: 'Task' object for properties.
    - `contact` string, uri — Contact marked as favorite, when this favorite points to a contact. Relation to Contact. By default it is returned as URI to related resource. Using parameter 'expand', it will return full entity. See: 'Contact' object for properties.
    - `custom_entity` string, uri — Custom entity record marked as favorite, when this favorite points to a custom entity. Relation to CustomEntity. By default it is returned as URI to related resource. Using parameter 'expand', it will return full entity. See: 'CustomEntity' object for properties.
    - `email` string, uri — Email marked as favorite, when this favorite points to an email. Relation to Email. By default it is returned as URI to related resource. Using parameter 'expand', it will return full entity. See: 'Email' object for properties.
    - `lead` string, uri — Lead marked as favorite. Set when lead_oppty_id resolves to a Lead. Relation to Lead. By default it is returned as URI to related resource. Using parameter 'expand', it will return full entity. See: 'Lead' object for properties.
    - `oppty` string, uri — Opportunity marked as favorite. Set when lead_oppty_id resolves to an Opportunity. Relation to Opportunity. By default it is returned as URI to related resource. Using parameter 'expand', it will return full entity. See: 'Opportunity' object for properties.
    - `owner` string, uri, required — User who marked the record as favorite. Relation to Client. By default it is returned as URI to related resource. Using parameter 'expand', it will return full entity. See: 'Client' object for properties.
    - `profile` string, uri — Screen profile marked as favorite, when this favorite points to a profile. Relation to Profile. By default it is returned as URI to related resource. Using parameter 'expand', it will return full entity. See: 'Profile' object for properties.
    - `project` string, uri — Project marked as favorite, when this favorite points to a project. Relation to Project. By default it is returned as URI to related resource. Using parameter 'expand', it will return full entity. See: 'Project' object for properties.
    - `quote` string, uri — Quote marked as favorite, when this favorite points to a quote. Relation to Quote. By default it is returned as URI to related resource. Using parameter 'expand', it will return full entity. See: 'Quote' object for properties.
    - `report` string, uri — Report marked as favorite, when this favorite points to a report. Relation to Report. By default it is returned as URI to related resource. Using parameter 'expand', it will return full entity. See: 'Report' object for properties.
    - `account_id` string, uuid — Id of the favorite account.
    - `activity_id` string, uuid — Id of the favorite appointment or task, or empty when not pointing to an activity.
    - `contact_id` string, uuid — Id of the favorite contact.
    - `custom_entity_id` string, uuid — Id of the favorite custom entity record.
    - `email_id` string, uuid — Id of the favorite email.
    - `lead_oppty_id` string, uuid — Id of the favorite lead or opportunity, or empty when not pointing to one.
    - `owner_id` string, uuid, required — Id of the owning user.
    - `profile_id` string, uuid — Id of the favorite screen profile.
    - `project_id` string, uuid — Id of the favorite project.
    - `quote_id` string, uuid — Id of the favorite quote.
    - `report_id` string, uuid — Id of the favorite report.
    - `revision` integer — Revision when entity was lastly changed.

## Other responses

- `404` — Sent when invalid ID is given
- `500` — unexpected error

---

[API](https://skmtc.net/aws/apis/pipeliner-cloud-api.md) · [All operations](https://skmtc.net/aws/apis/pipeliner-cloud-api/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/aws/pipeliner-cloud-api/versions/e8c12ae60aca/schema)