v1

latestOpenAPI 3.1.02026-08-061,5107704.5 MB

Quote

QuoteTypes.update

Modifies QuoteType or QuoteTypes with given id(s)

patch/entities/QuoteTypes/{id}

Path parameters

idstring uuid required

ID of QuoteType to update

Query parameters

validation-levelinteger

Specify validation level of QuoteType 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 quotes of this type.

form_lostobject

JSON definition of the form shown when archiving (losing) a quote of this type.

form_lost_enabledboolean

True when the lost form is required on archiving quotes of this type.

is_readonlyboolean

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

namestring

Name of the entity and its default text representation.

quote_process_idstring uuid

Id of the quote process.

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",
  "quote_process_id": "01234567-abcd-dcba-ffff-000000000000",
  "settings": "blob",
  "revision": 1
}

Response

Modification confirmation. Returns resulting QuoteType

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",
    "quote_process_id": "01234567-abcd-dcba-ffff-000000000000",
    "settings": "blob",
    "revision": 1
  }
}