Public lead form

Public lead capture forms

INFO

Har bir javob umumiy konvertda qaytadi — code, message, messages, status_code, time — foydali yuk esa data ichida. Quyidagi jadvallar faqat data ichini tavsiflaydi.

POST /public-lead-form/create

Create a new public lead capture form with custom fields, styling, and page settings.

So‘rov tanasi

Maydon	Tur	Majburiy	Tavsif
name	string	Ha	Display name of the lead form
organization_id	string	Ha	Organization ObjectId the form belongs to
responsible_id	string	Ha	Responsible user ObjectId
fields	object[]	Ha	Ordered list of form elements (header, paragraph, line, logo, file, field)
fields[].type	string	Ha	Element type. Mumkin qiymatlar: header, paragraph, line, logo, file, field
fields[].order	number	Ha	Display order index
fields[].name	string	Yo‘q	Display name for the element
fields[].placeholder	string	Yo‘q
fields[].validation_type	string	Yo‘q	Input validation rule (field elements only). Mumkin qiymatlar: phone, email
fields[].is_required	boolean	Yo‘q
fields[].color	string	Yo‘q
fields[].bold	boolean	Yo‘q
fields[].italic	boolean	Yo‘q
fields[].underline	boolean	Yo‘q
fields[].text_align	string	Yo‘q	Mumkin qiymatlar: left, right, center
fields[].size	number	Yo‘q
fields[].error_message	string	Yo‘q
fields[].custom_field_id	string	Yo‘q	Custom field ObjectId (field elements only)
page	object	Ha
page.background_color	string	Ha	Page background color (hex)
page.background_image	string	Yo‘q	Page background image URL (when background_type is image)
page.background_type	string	Ha	Mumkin qiymatlar: color, image
page.description	string	Yo‘q
page.header_active	boolean	Ha
page.header_type	string	Ha	Mumkin qiymatlar: text, image
page.header_text	string	Ha
page.header_text_color	string	Ha
page.header_image	string	Yo‘q
page.header_text_font_size	number	Ha
page.margin_left	number	Ha
page.margin_right	number	Ha
page.margin_top	number	Ha
page.position	string	Ha	Mumkin qiymatlar: left, right, center
settings	object	Ha
settings.state_id	string	Yo‘q	Default state ObjectId for submitted leads
settings.autocomplete	boolean	Ha	Auto-complete submitted leads
settings.success_message	string	Yo‘q
settings.has_redirect	boolean	Yo‘q
settings.redirect_url	string	Yo‘q
settings.redirect_delay	number	Yo‘q	Redirect delay in milliseconds
settings.submit	string	Yo‘q	Submit button label
settings.sidebar	object	Yo‘q
settings.sidebar.fields	object	Yo‘q	Map of sidebar field key to sidebar element
settings.sidebar.width	number	Ha
settings.sidebar.styles	object	Ha
settings.sidebar.type	string	Ha	Mumkin qiymatlar: left, right
styles	object	Ha
styles.field_margin	number	Ha
styles.margin	boolean	Ha
styles.field_background	string	Ha
styles.field_border_color	string	Ha
styles.field_form	string	Ha	Mumkin qiymatlar: rounded, square, line
styles.field_height	number	Ha
styles.submit_background	string	Ha
styles.submit_bold	boolean	Ha
styles.submit_italic	boolean	Ha
styles.submit_underline	boolean	Ha
styles.submit_border_radius	string	Ha	Mumkin qiymatlar: square, rounded
styles.submit_color	string	Ha
styles.submit_position	string	Ha	Mumkin qiymatlar: left, right, center
styles.submit_width	string	Ha	Mumkin qiymatlar: full_width, own
styles.width	number	Ha
styles.height	number	Ha
styles.form_border_color	string	Ha
styles.form_border_radius	number	Ha
styles.font	string	Ha
styles.font_color	string	Ha
styles.font_size	number	Ha
styles.form_paddings	boolean	Ha
styles.form_shadow	boolean	Ha
styles.background	string	Ha
styles.background_type	string	Ha	Mumkin qiymatlar: color, image
styles.name_position	string	Ha	Mumkin qiymatlar: left, top
css	string	Yo‘q	Optional custom CSS overrides

{
  "name": "string",
  "organization_id": "string",
  "responsible_id": "string",
  "fields": [
    {
      "type": "header",
      "order": 0,
      "name": "string",
      "placeholder": "string",
      "validation_type": "phone",
      "is_required": false,
      "color": "string",
      "bold": false,
      "italic": false,
      "underline": false,
      "text_align": "left",
      "size": 0,
      "error_message": "string",
      "custom_field_id": "string"
    }
  ],
  "page": {
    "background_color": "string",
    "background_image": "string",
    "background_type": "color",
    "description": "string",
    "header_active": false,
    "header_type": "text",
    "header_text": "string",
    "header_text_color": "string",
    "header_image": "string",
    "header_text_font_size": 0,
    "margin_left": 0,
    "margin_right": 0,
    "margin_top": 0,
    "position": "left"
  },
  "settings": {
    "state_id": "string",
    "autocomplete": false,
    "success_message": "string",
    "has_redirect": false,
    "redirect_url": "string",
    "redirect_delay": 0,
    "submit": "string",
    "sidebar": {
      "fields": {},
      "width": 0,
      "styles": {
        "background_color": null,
        "background_image": null
      },
      "type": "left"
    }
  },
  "styles": {
    "field_margin": 0,
    "margin": false,
    "field_background": "string",
    "field_border_color": "string",
    "field_form": "rounded",
    "field_height": 0,
    "submit_background": "string",
    "submit_bold": false,
    "submit_italic": false,
    "submit_underline": false,
    "submit_border_radius": "square",
    "submit_color": "string",
    "submit_position": "left",
    "submit_width": "full_width",
    "width": 0,
    "height": 0,
    "form_border_color": "string",
    "form_border_radius": 0,
    "font": "string",
    "font_color": "string",
    "font_size": 0,
    "form_paddings": false,
    "form_shadow": false,
    "background": "string",
    "background_type": "color",
    "name_position": "left"
  },
  "css": "string"
}

Javob

Maydon	Tur	Tavsif
name	string	Display name of the lead form
organization_id	string	Organization ObjectId the form belongs to
responsible_id	string	Responsible user ObjectId
fields	object[]	Ordered list of form elements (header, paragraph, line, logo, file, field)
fields[].type	string	Element type. Mumkin qiymatlar: header, paragraph, line, logo, file, field
fields[].order	number	Display order index
fields[].name	string	Display name for the element
fields[].placeholder	string
fields[].validation_type	string	Input validation rule (field elements only). Mumkin qiymatlar: phone, email
fields[].is_required	boolean
fields[].color	string
fields[].bold	boolean
fields[].italic	boolean
fields[].underline	boolean
fields[].text_align	string	Mumkin qiymatlar: left, right, center
fields[].size	number
fields[].error_message	string
fields[].custom_field_id	string	Custom field ObjectId (field elements only)
page	object
page.background_color	string	Page background color (hex)
page.background_image	string	Page background image URL (when background_type is image)
page.background_type	string	Mumkin qiymatlar: color, image
page.description	string
page.header_active	boolean
page.header_type	string	Mumkin qiymatlar: text, image
page.header_text	string
page.header_text_color	string
page.header_image	string
page.header_text_font_size	number
page.margin_left	number
page.margin_right	number
page.margin_top	number
page.position	string	Mumkin qiymatlar: left, right, center
settings	object
settings.state_id	string	Default state ObjectId for submitted leads
settings.autocomplete	boolean	Auto-complete submitted leads
settings.success_message	string
settings.has_redirect	boolean
settings.redirect_url	string
settings.redirect_delay	number	Redirect delay in milliseconds
settings.submit	string	Submit button label
settings.sidebar	object
settings.sidebar.fields	object	Map of sidebar field key to sidebar element
settings.sidebar.width	number
settings.sidebar.styles	object
settings.sidebar.type	string	Mumkin qiymatlar: left, right
styles	object
styles.field_margin	number
styles.margin	boolean
styles.field_background	string
styles.field_border_color	string
styles.field_form	string	Mumkin qiymatlar: rounded, square, line
styles.field_height	number
styles.submit_background	string
styles.submit_bold	boolean
styles.submit_italic	boolean
styles.submit_underline	boolean
styles.submit_border_radius	string	Mumkin qiymatlar: square, rounded
styles.submit_color	string
styles.submit_position	string	Mumkin qiymatlar: left, right, center
styles.submit_width	string	Mumkin qiymatlar: full_width, own
styles.width	number
styles.height	number
styles.form_border_color	string
styles.form_border_radius	number
styles.font	string
styles.font_color	string
styles.font_size	number
styles.form_paddings	boolean
styles.form_shadow	boolean
styles.background	string
styles.background_type	string	Mumkin qiymatlar: color, image
styles.name_position	string	Mumkin qiymatlar: left, top
css	string	Optional custom CSS overrides
_id	string	Public lead form ObjectId
is_deleted	boolean	Soft-delete flag
created_at	string (date-time)	Creation timestamp (ISO 8601)
updated_at	string (date-time)	Last update timestamp (ISO 8601)

{
  "code": 0,
  "message": "Success",
  "status_code": 200,
  "data": {
    "name": "string",
    "organization_id": "string",
    "responsible_id": "string",
    "fields": [
      {
        "type": "header",
        "order": 0,
        "name": "string",
        "placeholder": "string",
        "validation_type": "phone",
        "is_required": false,
        "color": "string",
        "bold": false,
        "italic": false,
        "underline": false,
        "text_align": "left",
        "size": 0,
        "error_message": "string",
        "custom_field_id": "string"
      }
    ],
    "page": {
      "background_color": "string",
      "background_image": "string",
      "background_type": "color",
      "description": "string",
      "header_active": false,
      "header_type": "text",
      "header_text": "string",
      "header_text_color": "string",
      "header_image": "string",
      "header_text_font_size": 0,
      "margin_left": 0,
      "margin_right": 0,
      "margin_top": 0,
      "position": "left"
    },
    "settings": {
      "state_id": "string",
      "autocomplete": false,
      "success_message": "string",
      "has_redirect": false,
      "redirect_url": "string",
      "redirect_delay": 0,
      "submit": "string",
      "sidebar": {
        "fields": {},
        "width": 0,
        "styles": {
          "background_color": null,
          "background_image": null
        },
        "type": "left"
      }
    },
    "styles": {
      "field_margin": 0,
      "margin": false,
      "field_background": "string",
      "field_border_color": "string",
      "field_form": "rounded",
      "field_height": 0,
      "submit_background": "string",
      "submit_bold": false,
      "submit_italic": false,
      "submit_underline": false,
      "submit_border_radius": "square",
      "submit_color": "string",
      "submit_position": "left",
      "submit_width": "full_width",
      "width": 0,
      "height": 0,
      "form_border_color": "string",
      "form_border_radius": 0,
      "font": "string",
      "font_color": "string",
      "font_size": 0,
      "form_paddings": false,
      "form_shadow": false,
      "background": "string",
      "background_type": "color",
      "name_position": "left"
    },
    "css": "string",
    "_id": "string",
    "is_deleted": false,
    "created_at": "2025-05-01T12:00:00Z",
    "updated_at": "2025-05-01T12:00:00Z"
  },
  "time": "2025-05-01T12:00:00Z"
}

PUT /public-lead-form/update/{id}

Update an existing public lead form by its ObjectId.

Yo‘l parametrlari

Parametr	Tur	Majburiy	Tavsif
id	string	Ha	Lead form ObjectId

So‘rov tanasi

Maydon	Tur	Majburiy	Tavsif
name	string	Ha	Display name of the lead form
organization_id	string	Ha	Organization ObjectId the form belongs to
responsible_id	string	Ha	Responsible user ObjectId
fields	object[]	Ha	Ordered list of form elements (header, paragraph, line, logo, file, field)
fields[].type	string	Ha	Element type. Mumkin qiymatlar: header, paragraph, line, logo, file, field
fields[].order	number	Ha	Display order index
fields[].name	string	Yo‘q	Display name for the element
fields[].placeholder	string	Yo‘q
fields[].validation_type	string	Yo‘q	Input validation rule (field elements only). Mumkin qiymatlar: phone, email
fields[].is_required	boolean	Yo‘q
fields[].color	string	Yo‘q
fields[].bold	boolean	Yo‘q
fields[].italic	boolean	Yo‘q
fields[].underline	boolean	Yo‘q
fields[].text_align	string	Yo‘q	Mumkin qiymatlar: left, right, center
fields[].size	number	Yo‘q
fields[].error_message	string	Yo‘q
fields[].custom_field_id	string	Yo‘q	Custom field ObjectId (field elements only)
page	object	Ha
page.background_color	string	Ha	Page background color (hex)
page.background_image	string	Yo‘q	Page background image URL (when background_type is image)
page.background_type	string	Ha	Mumkin qiymatlar: color, image
page.description	string	Yo‘q
page.header_active	boolean	Ha
page.header_type	string	Ha	Mumkin qiymatlar: text, image
page.header_text	string	Ha
page.header_text_color	string	Ha
page.header_image	string	Yo‘q
page.header_text_font_size	number	Ha
page.margin_left	number	Ha
page.margin_right	number	Ha
page.margin_top	number	Ha
page.position	string	Ha	Mumkin qiymatlar: left, right, center
settings	object	Ha
settings.state_id	string	Yo‘q	Default state ObjectId for submitted leads
settings.autocomplete	boolean	Ha	Auto-complete submitted leads
settings.success_message	string	Yo‘q
settings.has_redirect	boolean	Yo‘q
settings.redirect_url	string	Yo‘q
settings.redirect_delay	number	Yo‘q	Redirect delay in milliseconds
settings.submit	string	Yo‘q	Submit button label
settings.sidebar	object	Yo‘q
settings.sidebar.fields	object	Yo‘q	Map of sidebar field key to sidebar element
settings.sidebar.width	number	Ha
settings.sidebar.styles	object	Ha
settings.sidebar.type	string	Ha	Mumkin qiymatlar: left, right
styles	object	Ha
styles.field_margin	number	Ha
styles.margin	boolean	Ha
styles.field_background	string	Ha
styles.field_border_color	string	Ha
styles.field_form	string	Ha	Mumkin qiymatlar: rounded, square, line
styles.field_height	number	Ha
styles.submit_background	string	Ha
styles.submit_bold	boolean	Ha
styles.submit_italic	boolean	Ha
styles.submit_underline	boolean	Ha
styles.submit_border_radius	string	Ha	Mumkin qiymatlar: square, rounded
styles.submit_color	string	Ha
styles.submit_position	string	Ha	Mumkin qiymatlar: left, right, center
styles.submit_width	string	Ha	Mumkin qiymatlar: full_width, own
styles.width	number	Ha
styles.height	number	Ha
styles.form_border_color	string	Ha
styles.form_border_radius	number	Ha
styles.font	string	Ha
styles.font_color	string	Ha
styles.font_size	number	Ha
styles.form_paddings	boolean	Ha
styles.form_shadow	boolean	Ha
styles.background	string	Ha
styles.background_type	string	Ha	Mumkin qiymatlar: color, image
styles.name_position	string	Ha	Mumkin qiymatlar: left, top
css	string	Yo‘q	Optional custom CSS overrides
_id	string	Ha	Lead form ObjectId to update

{
  "name": "string",
  "organization_id": "string",
  "responsible_id": "string",
  "fields": [
    {
      "type": "header",
      "order": 0,
      "name": "string",
      "placeholder": "string",
      "validation_type": "phone",
      "is_required": false,
      "color": "string",
      "bold": false,
      "italic": false,
      "underline": false,
      "text_align": "left",
      "size": 0,
      "error_message": "string",
      "custom_field_id": "string"
    }
  ],
  "page": {
    "background_color": "string",
    "background_image": "string",
    "background_type": "color",
    "description": "string",
    "header_active": false,
    "header_type": "text",
    "header_text": "string",
    "header_text_color": "string",
    "header_image": "string",
    "header_text_font_size": 0,
    "margin_left": 0,
    "margin_right": 0,
    "margin_top": 0,
    "position": "left"
  },
  "settings": {
    "state_id": "string",
    "autocomplete": false,
    "success_message": "string",
    "has_redirect": false,
    "redirect_url": "string",
    "redirect_delay": 0,
    "submit": "string",
    "sidebar": {
      "fields": {},
      "width": 0,
      "styles": {
        "background_color": null,
        "background_image": null
      },
      "type": "left"
    }
  },
  "styles": {
    "field_margin": 0,
    "margin": false,
    "field_background": "string",
    "field_border_color": "string",
    "field_form": "rounded",
    "field_height": 0,
    "submit_background": "string",
    "submit_bold": false,
    "submit_italic": false,
    "submit_underline": false,
    "submit_border_radius": "square",
    "submit_color": "string",
    "submit_position": "left",
    "submit_width": "full_width",
    "width": 0,
    "height": 0,
    "form_border_color": "string",
    "form_border_radius": 0,
    "font": "string",
    "font_color": "string",
    "font_size": 0,
    "form_paddings": false,
    "form_shadow": false,
    "background": "string",
    "background_type": "color",
    "name_position": "left"
  },
  "css": "string",
  "_id": "string"
}

Javob

Javob tuzilishi quyidagi bilan bir xil: POST /public-lead-form/create.

GET /public-lead-form/get-by-id/{id}

Fetch a single public lead form by its ObjectId.

Yo‘l parametrlari

Parametr	Tur	Majburiy	Tavsif
id	string	Ha	Lead form ObjectId

So‘rov tanasi

So‘rov tanasi talab qilinmaydi.

Javob

Javob tuzilishi quyidagi bilan bir xil: POST /public-lead-form/create.

POST /public-lead-form/get-paging

Paginated list of public lead forms, optionally filtered by organization.

So‘rov tanasi

Maydon	Tur	Majburiy	Tavsif
page	number	Ha	Standart: 1
limit	number	Ha	Standart: 20
organization_id	string	Yo‘q	Filter by organization ObjectId

{
  "page": 1,
  "limit": 20,
  "organization_id": "string"
}

Javob

Maydon	Tur	Tavsif
total	number
list	object[]
list[].name	string	Display name of the lead form
list[].organization_id	string	Organization ObjectId the form belongs to
list[].responsible_id	string	Responsible user ObjectId
list[].fields	object[]	Ordered list of form elements (header, paragraph, line, logo, file, field)
list[].fields[].type	string	Element type. Mumkin qiymatlar: header, paragraph, line, logo, file, field
list[].fields[].order	number	Display order index
list[].fields[].name	string	Display name for the element
list[].fields[].placeholder	string
list[].fields[].validation_type	string	Input validation rule (field elements only). Mumkin qiymatlar: phone, email
list[].fields[].is_required	boolean
list[].fields[].color	string
list[].fields[].bold	boolean
list[].fields[].italic	boolean
list[].fields[].underline	boolean
list[].fields[].text_align	string	Mumkin qiymatlar: left, right, center
list[].fields[].size	number
list[].fields[].error_message	string
list[].fields[].custom_field_id	string	Custom field ObjectId (field elements only)
list[].page	object
list[].page.background_color	string	Page background color (hex)
list[].page.background_image	string	Page background image URL (when background_type is image)
list[].page.background_type	string	Mumkin qiymatlar: color, image
list[].page.description	string
list[].page.header_active	boolean
list[].page.header_type	string	Mumkin qiymatlar: text, image
list[].page.header_text	string
list[].page.header_text_color	string
list[].page.header_image	string
list[].page.header_text_font_size	number
list[].page.margin_left	number
list[].page.margin_right	number
list[].page.margin_top	number
list[].page.position	string	Mumkin qiymatlar: left, right, center
list[].settings	object
list[].settings.state_id	string	Default state ObjectId for submitted leads
list[].settings.autocomplete	boolean	Auto-complete submitted leads
list[].settings.success_message	string
list[].settings.has_redirect	boolean
list[].settings.redirect_url	string
list[].settings.redirect_delay	number	Redirect delay in milliseconds
list[].settings.submit	string	Submit button label
list[].settings.sidebar	object
list[].styles	object
list[].styles.field_margin	number
list[].styles.margin	boolean
list[].styles.field_background	string
list[].styles.field_border_color	string
list[].styles.field_form	string	Mumkin qiymatlar: rounded, square, line
list[].styles.field_height	number
list[].styles.submit_background	string
list[].styles.submit_bold	boolean
list[].styles.submit_italic	boolean
list[].styles.submit_underline	boolean
list[].styles.submit_border_radius	string	Mumkin qiymatlar: square, rounded
list[].styles.submit_color	string
list[].styles.submit_position	string	Mumkin qiymatlar: left, right, center
list[].styles.submit_width	string	Mumkin qiymatlar: full_width, own
list[].styles.width	number
list[].styles.height	number
list[].styles.form_border_color	string
list[].styles.form_border_radius	number
list[].styles.font	string
list[].styles.font_color	string
list[].styles.font_size	number
list[].styles.form_paddings	boolean
list[].styles.form_shadow	boolean
list[].styles.background	string
list[].styles.background_type	string	Mumkin qiymatlar: color, image
list[].styles.name_position	string	Mumkin qiymatlar: left, top
list[].css	string	Optional custom CSS overrides
list[]._id	string	Public lead form ObjectId
list[].is_deleted	boolean	Soft-delete flag
list[].created_at	string (date-time)	Creation timestamp (ISO 8601)
list[].updated_at	string (date-time)	Last update timestamp (ISO 8601)

{
  "code": 0,
  "message": "Success",
  "status_code": 200,
  "data": {
    "total": 0,
    "list": [
      {
        "name": "string",
        "organization_id": "string",
        "responsible_id": "string",
        "fields": [],
        "page": {
          "background_color": null,
          "background_image": null,
          "background_type": null,
          "description": null,
          "header_active": null,
          "header_type": null,
          "header_text": null,
          "header_text_color": null,
          "header_image": null,
          "header_text_font_size": null,
          "margin_left": null,
          "margin_right": null,
          "margin_top": null,
          "position": null
        },
        "settings": {
          "state_id": null,
          "autocomplete": null,
          "success_message": null,
          "has_redirect": null,
          "redirect_url": null,
          "redirect_delay": null,
          "submit": null,
          "sidebar": null
        },
        "styles": {
          "field_margin": null,
          "margin": null,
          "field_background": null,
          "field_border_color": null,
          "field_form": null,
          "field_height": null,
          "submit_background": null,
          "submit_bold": null,
          "submit_italic": null,
          "submit_underline": null,
          "submit_border_radius": null,
          "submit_color": null,
          "submit_position": null,
          "submit_width": null,
          "width": null,
          "height": null,
          "form_border_color": null,
          "form_border_radius": null,
          "font": null,
          "font_color": null,
          "font_size": null,
          "form_paddings": null,
          "form_shadow": null,
          "background": null,
          "background_type": null,
          "name_position": null
        },
        "css": "string",
        "_id": "string",
        "is_deleted": false,
        "created_at": "2025-05-01T12:00:00Z",
        "updated_at": "2025-05-01T12:00:00Z"
      }
    ]
  },
  "time": "2025-05-01T12:00:00Z"
}

DELETE /public-lead-form/delete/{id}

Soft-delete a public lead form by its ObjectId.

Yo‘l parametrlari

Parametr	Tur	Majburiy	Tavsif
id	string	Ha	Lead form ObjectId to delete

So‘rov tanasi

So‘rov tanasi talab qilinmaydi.

Javob

{
  "code": 0,
  "message": "Success",
  "status_code": 200,
  "data": "ok",
  "time": "2025-05-01T12:00:00Z"
}

---

Bu sahifa OpenAPI spetsifikatsiyasidan yaratilgan.