Sign in

v1

latestOpenAPI 3.1.02026-08-061,5107704.5 MB
Activity

AppointmentTypes.update

Modifies AppointmentType or AppointmentTypes with given id(s)

patch/entities/AppointmentTypes/{id}

Path parameters

idstring uuid required

ID of AppointmentType to update

Query parameters

validation-levelinteger

Specify validation level of AppointmentType 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 form layout used by the UI when creating or editing appointments of this type.

icon0 | 1 | 2 | 3 | 4 | 5 | 6 | 7 | 8 | 9 | 10 | 11 | 12 | 13 | 14 | 15 | 16 | 17 | 18 | 19 | 20 | 21 | 22 | 23

Icon used to display appointments of this type in the UI.

Integer enum value: 0 - GeneralIcon, 1 - Task, 2 - Appointment, 3 - Call, 4 - Mail, 5 - Message, 6 - TicketingIntegration, 7 - DocumentManagement, 8 - EventManagement, 9 - AccountingSystem, 10 - MarketingCommunicationSystems, 11 - OrderProcessing, 12 - WebServices, 13 - ReturnMerchandiseAuthorizationSystems, 14 - SalesAutomatization, 15 - SmsMessaging, 16 - ErpSystems, 17 - DataAnalytics, 18 - Warehouses, 19 - ContactManagement, 20 - ContentManagementSystems, 21 - InventorySystems, 22 - Workflow, 23 - AssetManagementSystem

is_readonlyboolean

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

namestring

Name of the entity and its default text representation.

revisioninteger

Revision when entity was lastly changed.

Example request

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

Response

Modification confirmation. Returns resulting AppointmentType

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",
    "revision": 1
  }
}