COcoevera
Lead & Opportunity

LeadTypes.update

Changes fields of the LeadType record with the given id; fields left out keep their values.

patch/entities/LeadTypes/{id}

Request

Path parameters

idstring uuid required

Id of the LeadType record to update.

Query parameters

validation-levelinteger

Bit mask that relaxes validation on this write. 0 (the default) validates everything. Bits: 2 skip unchanged fields, 4 skip admin-defined validations, 8 allow read-only fields, 16 skip relation checks, 32 skip value checks, 64 skip invalid recalculations, 128 skip step-checklist gates, 256 add conditional field requirements, 512 skip uniqueness checks. Add bits together (20 = 4 + 16); member names and comma lists such as 4,16 work too. A value with an internal-only bit is refused with HTTP 400, code 117.

Request body

form_editobject

JSON definition of the form layout used by the UI when creating or editing leads of this type. This payload conforms to the Form JSON Schema (see the linked schema).

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. This payload conforms to the Form JSON Schema (see the linked schema).

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 that leads of this type follow.

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. This payload conforms to the EntityTypeSettings JSON Schema (see the linked schema).

revisioninteger

Revision when entity was lastly changed.

Example request

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

Response

The changed LeadType record.

successboolean

True when the request 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
  }
}

Changes

No recorded changes to this operation across all 1 revision of this API.