COcoevera
Interface

InterfacePreviews.create

Creates a InterfacePreview record.

post/entities/InterfacePreviews

Request

Query parameters

validation-levelinteger

Bit mask that relaxes validation on this write. 0 (the default) validates everything. Bits: 2 skip unchanged fields, 4 skip admin-defined validations, 8 allow read-only fields, 16 skip relation checks, 32 skip value checks, 64 skip invalid recalculations, 128 skip step-checklist gates, 256 add conditional field requirements, 512 skip uniqueness checks. Add bits together (20 = 4 + 16); member names and comma lists such as 4,16 work too. A value with an internal-only bit is refused with HTTP 400, code 117.

Request body

modifiedstring date-time

Last modification time.

createdstring date-time

Creation time.

account_type_idstring uuid

Id of the account type the interface preview applies to.

appointment_type_idstring uuid

Id of the appointment type the interface preview applies to.

card_field_idsobject required

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

chartsobject required

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

contact_type_idstring uuid

Id of the contact type the interface preview applies to.

custom_entity_type_idstring uuid

Id of the custom entity type the interface preview applies to.

detail_tabsobject required

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

detail_widgetsobject required

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

field_idsobject required

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

lead_type_idstring uuid

Id of the lead type the interface preview applies to.

oppty_type_idstring uuid

Id of the opportunity type.

product_type_idstring uuid

Id of the product type the interface preview applies to.

project_type_idstring uuid

Id of the project type the interface preview applies to.

quote_type_idstring uuid

Id of the quote type the interface preview applies to.

settingsstring 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_idstring uuid

Id of the task type the interface preview applies to.

is_publishedboolean

True when the interface preview is published; false while it exists only as an unpublished draft.

revisioninteger

Revision when entity was lastly changed.

entity_type_idstring uuid required

Id of the type the interface preview is configured for, derived from whichever of the per-entity-type relations is set.

Example request

{
  "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"
}

Response

The created InterfacePreview record.

successboolean

True when the request 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
  }
}

Changes

No recorded changes to this operation across all 1 revision of this API.