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

# FormViews.update

`PATCH /entities/FormViews/{id}`

Modifies FormView or FormViews with given id(s)

## Path parameters

- `id` string, uuid, required

## Query parameters

- `validation-level` integer

## Request body

- UpdateFormViewInput
  - `account_type_id` string, uuid — Id of the account type.
  - `contact_type_id` string, uuid — Id of the contact type.
  - `hidden_item_ids` object — Ids of fields and webresources hidden from the form for this view.
  - `item_colors` object — Per-item color overrides for fields and webresources in the form, keyed by item id.
  - `lead_type_id` string, uuid — Id of the lead type.
  - `name` string — Name of the entity and its default text representation.
  - `oppty_type_id` string, uuid — Id of the opportunity type.
  - `owner_id` string, uuid — Id of the owning user.
  - `share_mode` 0 | 1 | 2 | 3 — Field whose values are strictly defined with an enumeration of values. Integer enum value: 0 - Standard, 1 - Private, 2 - AllView, 3 - AllEdit
  - `use_lang` boolean — When true, the form view name is treated as a translation key and localized in the UI; otherwise the literal name is shown.
  - `revision` integer — Revision when entity was lastly changed.
  - `sharing_units` object[] — Sales units that have been granted shared access to this form view (custom share mode).
    - `id` string, uri
  - `sharing_clients` object[] — Users that have been granted shared access to this form view (custom share mode).
    - `id` string, uri

## Response `200`

Modification confirmation. Returns resulting FormView

- object
  - `success` boolean — True when response succeeded, false on error.
  - `data` FormView
    - `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_type` string, uri — Account type the form view applies to. Set when the form view targets accounts. Relation to AccountType. By default it is returned as URI to related resource. Using parameter 'expand', it will return full entity. See: 'AccountType' object for properties.
    - `contact_type` string, uri — Contact type the form view applies to. Set when the form view targets contacts. Relation to ContactType. By default it is returned as URI to related resource. Using parameter 'expand', it will return full entity. See: 'ContactType' object for properties.
    - `lead_type` string, uri — Lead type the form view applies to. Set when the form view targets leads. Relation to LeadType. By default it is returned as URI to related resource. Using parameter 'expand', it will return full entity. See: 'LeadType' object for properties.
    - `oppty_type` string, uri — Opportunity type the form view applies to. Set when the form view targets opportunities. Relation to OpportunityType. By default it is returned as URI to related resource. Using parameter 'expand', it will return full entity. See: 'OpportunityType' object for properties.
    - `owner` string, uri, required — User who owns the form view. 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.
    - `account_type_id` string, uuid — Id of the account type.
    - `contact_type_id` string, uuid — Id of the contact type.
    - `hidden_item_ids` object, required — Ids of fields and webresources hidden from the form for this view.
    - `item_colors` object, required — Per-item color overrides for fields and webresources in the form, keyed by item id.
    - `lead_type_id` string, uuid — Id of the lead type.
    - `name` string, required — Name of the entity and its default text representation.
    - `oppty_type_id` string, uuid — Id of the opportunity type.
    - `owner_id` string, uuid, required — Id of the owning user.
    - `share_mode` 0 | 1 | 2 | 3 — Field whose values are strictly defined with an enumeration of values. Integer enum value: 0 - Standard, 1 - Private, 2 - AllView, 3 - AllEdit
    - `use_lang` boolean — When true, the form view name is treated as a translation key and localized in the UI; otherwise the literal name is shown.
    - `revision` integer — Revision when entity was lastly changed.
    - `entity_type_id` string, uuid, required — Id of the type the form view is configured for, derived from whichever of the per-entity-type relations is set.
    - `sharing_units` string[] — Sales units that have been granted shared access to this form view (custom share mode).
    - `sharing_clients` string[] — Users that have been granted shared access to this form view (custom share mode).

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