--- title: "InterfacePreviews.update" method: PATCH path: "/entities/InterfacePreviews/{id}" tags: ["Interface"] --- # InterfacePreviews.update `PATCH /entities/InterfacePreviews/{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/InterfacePreviews/{id}` - Auth: HTTP basic - TypeScript: (a function with typed inputs; its response is checked against the schema) Changes fields of the InterfacePreview record with the given id; fields left out keep their values. ## Path parameters - `id` string, uuid, required ## Query parameters - `validation-level` integer ## Request body - UpdateInterfacePreviewInput: Field values to change on an InterfacePreview record; fields left out keep their values. - `card_field_ids` object: Ordered ids of fields shown on the record's compact card view. - `charts` object: Chart configurations shown in the preview, each linked to a related entity (e.g. recent activities, related contacts, comments). - `detail_tabs` object: Tab configurations shown on the record's detail screen (Detail tab plus related-entity and lookup tabs). - `detail_widgets` object: Widget configurations shown on the record's detail screen sidebar (e.g. Status, KPIs). - `field_ids` object: Ordered ids of fields shown in the record's preview pane. - `settings` string, binary: Layout-customization settings for the preview (e.g. is_layout_customization_enabled). This payload conforms to the `InterfacePreviewCustomSettings` JSON Schema (see the linked schema). - `revision` integer: Revision when entity was lastly changed. ## Response `200` The changed InterfacePreview record. - object - `success` boolean: True when the request succeeded; false on error. - `data` InterfacePreview: Layout of how records of an entity type are previewed in the app: preview and card fields, detail tabs, widgets and charts. - `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. - `has_draft` boolean, required: True when the record has unpublished draft changes, including pending translation changes, that can be published. - `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 interface preview applies to. 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. - `appointment_type` string, uri: Appointment type the interface preview applies to. Related AppointmentType record, returned as the URI of the record. With the 'expand' parameter the full record is returned instead; see 'AppointmentType' for its fields. - `contact_type` string, uri: Contact type the interface preview applies to. 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. - `custom_entity_type` string, uri: Custom entity type the interface preview applies to. Related CustomEntityType record, returned as the URI of the record. With the 'expand' parameter the full record is returned instead; see 'CustomEntityType' for its fields. - `lead_type` string, uri: Lead type the interface preview applies to. 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 interface preview applies to. 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. - `product_type` string, uri: Product type the interface preview applies to. Related ProductType record, returned as the URI of the record. With the 'expand' parameter the full record is returned instead; see 'ProductType' for its fields. - `project_type` string, uri: Project type the interface preview applies to. Related ProjectType record, returned as the URI of the record. With the 'expand' parameter the full record is returned instead; see 'ProjectType' for its fields. - `quote_type` string, uri: Quote type the interface preview applies to. Related QuoteType record, returned as the URI of the record. With the 'expand' parameter the full record is returned instead; see 'QuoteType' for its fields. - `task_type` string, uri: Task type the interface preview applies to. Related TaskType record, returned as the URI of the record. With the 'expand' parameter the full record is returned instead; see 'TaskType' for its fields. - `account_type_id` string, uuid: Id of the account type the interface preview applies to. - `appointment_type_id` string, uuid: Id of the appointment type the interface preview applies to. - `card_field_ids` object, required: Ordered ids of fields shown on the record's compact card view. - `charts` object, required: Chart configurations shown in the preview, each linked to a related entity (e.g. recent activities, related contacts, comments). - `contact_type_id` string, uuid: Id of the contact type the interface preview applies to. - `custom_entity_type_id` string, uuid: Id of the custom entity type the interface preview applies to. - `detail_tabs` object, required: Tab configurations shown on the record's detail screen (Detail tab plus related-entity and lookup tabs). - `detail_widgets` object, required: Widget configurations shown on the record's detail screen sidebar (e.g. Status, KPIs). - `field_ids` object, required: Ordered ids of fields shown in the record's preview pane. - `lead_type_id` string, uuid: Id of the lead type the interface preview applies to. - `oppty_type_id` string, uuid: Id of the opportunity type. - `product_type_id` string, uuid: Id of the product type the interface preview applies to. - `project_type_id` string, uuid: Id of the project type the interface preview applies to. - `quote_type_id` string, uuid: Id of the quote type the interface preview applies to. - `settings` string, binary, required: Layout-customization settings for the preview (e.g. is_layout_customization_enabled). This payload conforms to the `InterfacePreviewCustomSettings` JSON Schema (see the linked schema). - `task_type_id` string, uuid: Id of the task type the interface preview applies to. - `is_published` boolean: True when the interface preview is published; false while it exists only as an unpublished draft. - `revision` integer: Revision when entity was lastly changed. - `entity_type_id` string, uuid, required: Id of the type the interface preview is configured for, derived from whichever of the per-entity-type relations is set. - `entity_type` 1 | 2 | 3 | 4 | 5 | 6 | 7 | 8 | 9 | 10 | 11 | 12, required: Entity kind the interface preview applies to (Account, Lead, Opportunity, Contact, Task, Appointment, Project, Quote, CustomEntity, or Product). Derived from whichever of the per-entity-type relations is set. Integer enum value: 1 - Lead, 2 - Account, 3 - Contact, 4 - Opportunity, 5 - Task, 6 - Appointment, 7 - OpptyProductRelation, 8 - Project, 9 - Quote, 10 - OnlineForm, 11 - CustomEntity, 12 - Product ## 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)