Sign in

v1

latestOpenAPI 3.1.02026-08-061,5107704.5 MB
Interface

InterfacePreviews.update

Modifies InterfacePreview or InterfacePreviews with given id(s)

patch/entities/InterfacePreviews/{id}

Path parameters

idstring uuid required

ID of InterfacePreview to update

Query parameters

validation-levelinteger

Specify validation level of InterfacePreview on update. Use them as bit mask: 0 - validate each field on entity, 2 - validate only changed fields, 4 - validate only system fields, 8 - allows to override readonly fields, 16 - allows to set entity on deleted relationship.

Request body

card_field_idsobject

Ordered ids of fields shown on the record's compact card view.

chartsobject

Chart configurations shown in the preview, each linked to a related entity (e.g. recent activities, related contacts, comments).

detail_tabsobject

Tab configurations shown on the record's detail screen (Detail tab plus related-entity and lookup tabs).

detail_widgetsobject

Widget configurations shown on the record's detail screen sidebar (e.g. Status, KPIs).

field_idsobject

Ordered ids of fields shown in the record's preview pane.

settingsstring binary

Layout-customization settings for the preview (e.g. is_layout_customization_enabled).

revisioninteger

Revision when entity was lastly changed.

Example request

{
  "settings": "blob",
  "revision": 1
}

Response

Modification confirmation. Returns resulting InterfacePreview

successboolean

True when response succeeded, false on error.

Example response

{
  "success": true,
  "data": {
    "id": "01234567-abcd-dcba-ffff-000000000000",
    "modified": "2019-01-01T00:00:00",
    "created": "2019-01-01T00:00:00",
    "account_type_id": "01234567-abcd-dcba-ffff-000000000000",
    "appointment_type_id": "01234567-abcd-dcba-ffff-000000000000",
    "contact_type_id": "01234567-abcd-dcba-ffff-000000000000",
    "custom_entity_type_id": "01234567-abcd-dcba-ffff-000000000000",
    "lead_type_id": "01234567-abcd-dcba-ffff-000000000000",
    "oppty_type_id": "01234567-abcd-dcba-ffff-000000000000",
    "product_type_id": "01234567-abcd-dcba-ffff-000000000000",
    "project_type_id": "01234567-abcd-dcba-ffff-000000000000",
    "quote_type_id": "01234567-abcd-dcba-ffff-000000000000",
    "settings": "blob",
    "task_type_id": "01234567-abcd-dcba-ffff-000000000000",
    "revision": 1,
    "entity_type_id": "01234567-abcd-dcba-ffff-000000000000",
    "entity_type": 1
  }
}