Custom sections

Base URL https://api.leadx.in/api/key/protected. Every request needs an apikey header — see Authentication.

6 endpoints.

GET /custom-section

Get all custom section.

Auth apikey

:::note Used by the web app components/CustomField.jsx :::

Query parameters — the standard list contract: p, n, sortBy, sortOrder, searchBy, searchValue, filters, advancedFilters, ids, nids. See Pagination and Filtering.

Response — data is an array of CustomSection objects, alongside the pagination fields described in Response format. (Resource deduced from the collections this handler reads, not read off an explicit return.)

POST /custom-section

Create custom section.

Auth apikey · Success 200

:::note Used by the web app components/CustomField.jsx :::

Request body

Field	Default	Notes
name	—
panel	—	lead, contact or productService.
description	—
order	—
hide	—

Required: name, panel.

Response — data is one CustomSection object. (Resource deduced from the collections this handler reads, not read off an explicit return.)

Errors CustomSectionNameAlreadyExists_400

DELETE /custom-section

Delete custom section.

Auth apikey · Success 200

:::note Used by the web app components/CustomField.jsx :::

Request body

Field	Default	Notes
ids	[]	Documents to act on.
nids	[]	Documents to exclude.
selectAll	false	Act on everything matching the query-string filter instead of an id list.
filters	{}

Response — data is one CustomSection object. (Resource deduced from the collections this handler reads, not read off an explicit return.)

Errors NoCustomSectionSelected_400

GET /custom-section/:id

Get custom section.

Auth apikey

:::note Used by the web app components/CustomField.jsx :::

Path parameters

Name
id	Required

Response — data is one CustomSection object.

Errors CustomSectionNotFound_400

PUT /custom-section/:id

Update custom section.

Auth apikey · Success 200

:::note Used by the web app components/CustomField.jsx :::

Path parameters

Name
id	Required

Request body

Field	Default	Notes
panel	—	lead, contact or productService.

Response — data is one CustomSection object. (Resource deduced from the collections this handler reads, not read off an explicit return.)

Errors CustomSectionNotFound_400

PUT /custom-section/reorder

Reorder sections.

Auth apikey

Request body

Field	Default	Notes
sections	[]
panel	—	lead, contact or productService.

Response — data is one CustomSection object. (Resource deduced from the collections this handler reads, not read off an explicit return.)