COcoevera
Interface

InterfacePreviews.batch_create_or_update

Creates or updates InterfacePreview records in one request: an item with an id updates that record, an item without one creates a new record.

post/entities/InterfacePreviews/batch-modify

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.

rollback-method0 | 1

0, the default: one failed item fails the whole batch (HTTP 422, or 404 for an unknown id) and nothing is written. 1: the valid items are written and the call answers 200 with success false and one result per item, an id or an error, in input order. Check every item.

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). This payload conforms to the InterfacePreviewCustomSettings JSON Schema (see the linked schema).

revisioninteger

Revision when entity was lastly changed.

idstring uuid

ID of object to update.

Example request

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

Response

Result per item, in request order: the id of the created or updated record, or the error.

successboolean

True when the request succeeded; false on error.

Example response

{
  "success": true,
  "data": [
    {
      "http_status": 400,
      "code": 117,
      "name": "ERROR_PARAMETER_INVALID"
    }
  ]
}

Changes

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