--- title: "FormViews.update" method: PATCH path: "/entities/FormViews/{id}" tags: ["Form"] --- # FormViews.update `PATCH /entities/FormViews/{id}` ## Request - Base URL: `https://us-east.api.coevera.com/api/v100/rest/spaces/your_space_id` - URL: `https://us-east.api.coevera.com/api/v100/rest/spaces/your_space_id/entities/FormViews/{id}` - Auth: HTTP basic - TypeScript: (a function with typed inputs; its response is checked against the schema) Changes fields of the FormView record with the given id; fields left out keep their values. ## Path parameters - `id` string, uuid, required ## Query parameters - `validation-level` integer ## Request body - UpdateFormViewInput: Field values to change on a FormView record; fields left out keep their values. - `account_type_id` string, uuid: Id of the account type the form view applies to. Set when the form view targets accounts. - `contact_type_id` string, uuid: Id of the contact type the form view applies to. Set when the form view targets contacts. - `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 the form view applies to. Set when the form view targets leads. - `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: Who besides the owner can use the form view: nobody (Private, the default), the users and sales units in sharing_clients and sharing_units (Standard), or all users (AllView to view, AllEdit to also edit). 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, uuid: Id of the related FormViewSharingSalesUnitRelation record. - `sharing_clients` object[]: Users that have been granted shared access to this form view (custom share mode). - `id` string, uuid: Id of the related FormViewSharingClientRelation record. ## Response `200` The changed FormView record. - object - `success` boolean: True when the request succeeded; false on error. - `data` FormView: Variant of the form of an account, contact, lead or opportunity type that hides or colors selected fields; owned by a user and can be shared. - `is_delete_protected` boolean, required: True when the record is protected against deletion because it must always exist in the space. Deleting a record that is not protected can still fail on other checks. Read-only. - `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. Related AccountType record, returned as the URI of the record. With the 'expand' parameter the full record is returned instead; see 'AccountType' for its fields. - `contact_type` string, uri: Contact type the form view applies to. Set when the form view targets contacts. Related ContactType record, returned as the URI of the record. With the 'expand' parameter the full record is returned instead; see 'ContactType' for its fields. - `lead_type` string, uri: Lead type the form view applies to. Set when the form view targets leads. Related LeadType record, returned as the URI of the record. With the 'expand' parameter the full record is returned instead; see 'LeadType' for its fields. - `oppty_type` string, uri: Opportunity type the form view applies to. Set when the form view targets opportunities. Related OpportunityType record, returned as the URI of the record. With the 'expand' parameter the full record is returned instead; see 'OpportunityType' for its fields. - `owner` string, uri, required: User who owns the form view. Related Client record, returned as the URI of the record. With the 'expand' parameter the full record is returned instead; see 'Client' for its fields. - `account_type_id` string, uuid: Id of the account type the form view applies to. Set when the form view targets accounts. - `contact_type_id` string, uuid: Id of the contact type the form view applies to. Set when the form view targets contacts. - `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 the form view applies to. Set when the form view targets leads. - `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: Who besides the owner can use the form view: nobody (Private, the default), the users and sales units in sharing_clients and sharing_units (Standard), or all users (AllView to view, AllEdit to also edit). 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 - `400`: Bad request: a bad or unknown parameter (codes 117, 118), a missing permission (code 50), conflicting data (code 2002) or any other API error. The REST API answers 400 where others answer 403 or 409; check `code`. - `401`: Not authenticated: missing or wrong credentials, a credential of another space, or an expired token (code 401, ERROR_UNAUTHORIZED). - `404`: No such record or entity (code 143 ERROR_NO_ENTITY, or 2006 ERROR_UNKNOWN_TYPE). - `422`: Validation failed (code 40000, with the failing fields) or a required parameter is missing (code 119). By default one failed item fails a whole batch and nothing is written. - `429`: Too many requests (code 182). Wait for the seconds in Retry-After, then retry. - `500`: Unexpected server error (code 1000, ERROR_UNKNOWN). --- [API](https://skmtc.dev/coevera/apis/coevera-crm-api.md) - [All operations](https://skmtc.dev/coevera/apis/coevera-crm-api/llms.txt) - [OpenAPI document](https://skmtc.dev/coevera/apis/coevera-crm-api/revisions/40ebbc83f179?raw)