v1

latestOpenAPI 3.1.02026-08-061,5107704.5 MB

Account

AccountTypes.update

Modifies AccountType or AccountTypes with given id(s)

patch/entities/AccountTypes/{id}

Path parameters

idstring uuid required

ID of AccountType to update

Query parameters

validation-levelinteger

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

form_editobject

JSON definition of the edit form layout used by the UI when creating or editing accounts of this type. Contains tabs, sections, and field placement.

is_readonlyboolean

True when the account type is system-managed and cannot be edited or deleted by users.

namestring

Name of the entity and its default text representation.

settingsstring binary

Per-type configuration for records of this entity type, e.g. allowed task and appointment types that may be linked to records of this type.

revisioninteger

Revision when entity was lastly changed.

Example request

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

Response

Modification confirmation. Returns resulting AccountType

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",
    "name": "string",
    "settings": "blob",
    "revision": 1
  }
}