---
title: "LeadTypes.create"
method: POST
path: "/entities/LeadTypes"
tags: ["Lead & Opportunity"]
---

# LeadTypes.create

`POST /entities/LeadTypes`

Creates new LeadType

## Query parameters

- `validation-level` integer

## Response `201`

Creation confirmation. Returns created LeadType

- object
  - `success` boolean — True when response succeeded, false on error.
  - `data` LeadType
    - `id` string, uuid, required — Unique identifier of entity.
    - `is_deleted` boolean — Specifies if the entity is considered deleted.
    - `modified` string, date-time — Last modification time.
    - `created` string, date-time — Creation time.
    - `lead_process` string, uri, required — Lead process (pipeline) this lead type follows. Relation to LeadProcess. By default it is returned as URI to related resource. Using parameter 'expand', it will return full entity. See: 'LeadProcess' object for properties.
    - `form_edit` object — JSON definition of the form layout used by the UI when creating or editing leads of this type.
    - `form_lost` object — 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_enabled` boolean, required — True when the lost form is required on archiving leads of this type.
    - `is_readonly` boolean, required — True when the lead type is system-managed and cannot be edited or deleted by users.
    - `lead_process_id` string, uuid, required — Id of the lead process.
    - `name` string, required — Name of the entity and its default text representation.
    - `settings` string, binary, required — 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.
    - `is_published` boolean — True when the entity configuration is published; false while it exists only as an unpublished draft.
    - `revision` integer — Revision when entity was lastly changed.
    - `has_draft` boolean, required — Set to True if draft for entity exists and can be published
    - `is_delete_protected` boolean, required — Tells if the entity instance is protected against delete (Entities that need to be present in the system at any time). Delete action still may fail if entity is deletable, due some other additional validations.
    - `form_edit_api` object, required — API-friendly form definition. Returns the published form merged with any pending draft changes; read via this field, modify via the underlying form_edit / form_lost field through drafts.
    - `can_change_readonly` boolean — Returns if user can change readonly flag on this entity_type.
    - `form_lost_api` object, required — API-friendly form definition. Returns the published form merged with any pending draft changes; read via this field, modify via the underlying form_edit / form_lost field through drafts.

## Other responses

- `500` — unexpected error

---

[API](https://skmtc.dev/aws/apis/pipeliner-cloud-api.md) · [All operations](https://skmtc.dev/aws/apis/pipeliner-cloud-api/llms.txt) · [OpenAPI document](https://skmtc-service-production.skmtc.workers.dev/v1/apis/aws/pipeliner-cloud-api/revisions/e8c12ae60aca/schema)