Sign in

v1

latestOpenAPI 3.1.02026-08-061,5107704.5 MB
Lead & Opportunity

LeadTypes.update

Modifies LeadType or LeadTypes with given id(s)

patch/entities/LeadTypes/{id}

Path parameters

idstring uuid required

ID of LeadType to update

Query parameters

validation-levelinteger

Specify validation level of LeadType 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 leads of this type.

form_lostobject

JSON definition of the form shown when archiving (losing) a lead of this type. Used to capture reason of close and any required closing fields.

form_lost_enabledboolean

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

is_readonlyboolean

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

lead_process_idstring uuid

Id of the lead process.

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

{
  "lead_process_id": "01234567-abcd-dcba-ffff-000000000000",
  "name": "string",
  "settings": "blob",
  "revision": 1
}

Response

Modification confirmation. Returns resulting LeadType

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