Sign in

v1

latestOpenAPI 3.1.02026-08-061,5107704.5 MB
Form

FormViews.update

Modifies FormView or FormViews with given id(s)

patch/entities/FormViews/{id}

Path parameters

idstring uuid required

ID of FormView to update

Query parameters

validation-levelinteger

Specify validation level of FormView 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

account_type_idstring uuid

Id of the account type.

contact_type_idstring uuid

Id of the contact type.

hidden_item_idsobject

Ids of fields and webresources hidden from the form for this view.

item_colorsobject

Per-item color overrides for fields and webresources in the form, keyed by item id.

lead_type_idstring uuid

Id of the lead type.

namestring

Name of the entity and its default text representation.

oppty_type_idstring uuid

Id of the opportunity type.

owner_idstring uuid

Id of the owning user.

share_mode0 | 1 | 2 | 3

Field whose values are strictly defined with an enumeration of values.

Integer enum value: 0 - Standard, 1 - Private, 2 - AllView, 3 - AllEdit

use_langboolean

When true, the form view name is treated as a translation key and localized in the UI; otherwise the literal name is shown.

revisioninteger

Revision when entity was lastly changed.

Example request

{
  "account_type_id": "01234567-abcd-dcba-ffff-000000000000",
  "contact_type_id": "01234567-abcd-dcba-ffff-000000000000",
  "lead_type_id": "01234567-abcd-dcba-ffff-000000000000",
  "name": "string",
  "oppty_type_id": "01234567-abcd-dcba-ffff-000000000000",
  "owner_id": "01234567-abcd-dcba-ffff-000000000000",
  "revision": 1
}

Response

Modification confirmation. Returns resulting FormView

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",
    "contact_type_id": "01234567-abcd-dcba-ffff-000000000000",
    "lead_type_id": "01234567-abcd-dcba-ffff-000000000000",
    "name": "string",
    "oppty_type_id": "01234567-abcd-dcba-ffff-000000000000",
    "owner_id": "01234567-abcd-dcba-ffff-000000000000",
    "revision": 1,
    "entity_type_id": "01234567-abcd-dcba-ffff-000000000000"
  }
}