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.)

cURL

curl -X GET 'https://api.leadx.in/api/key/protected/custom-section?p=1&n=25' \
  -H 'apikey: $LEADX_API_KEY'

fetch

// Node 18+ and every modern browser ship fetch.
const res = await fetch('https://api.leadx.in/api/key/protected/custom-section?p=1&n=25', {
  method: 'GET',
  headers: {
    apikey: process.env.LEADX_API_KEY,
  },
});

const payload = await res.json();
if (!res.ok) {
  // Errors carry { status, success, message } — not the success envelope.
  throw new Error(`${res.status} ${payload.message}`);
}

console.log(payload.data);

axios

import axios from 'axios';

const leadx = axios.create({
  baseURL: 'https://api.leadx.in/api/key/protected',
  headers: { apikey: process.env.LEADX_API_KEY },
});

try {
  const { data } = await leadx.get(
    '/custom-section?p=1&n=25'
  );
  console.log(data.data);
} catch (err) {
  // axios throws on 4xx/5xx; the envelope is on err.response.data.
  throw new Error(`${err.response?.status} ${err.response?.data?.message ?? err.message}`);
}

Node (no deps)

import { request } from 'node:https';

// The dependency-free version, for somewhere fetch is not available.
const send = (payload) =>
  new Promise((resolve, reject) => {
    const req = request(
      'https://api.leadx.in/api/key/protected/custom-section?p=1&n=25',
      {
        method: 'GET',
        headers: {
          apikey: process.env.LEADX_API_KEY,
        },
      },
      (res) => {
        let raw = '';
        res.on('data', (chunk) => { raw += chunk; });
        res.on('end', () => {
          const body = JSON.parse(raw);
          if (res.statusCode >= 400) reject(new Error(`${res.statusCode} ${body.message}`));
          else resolve(body);
        });
      },
    );
    req.on('error', reject);
    
    req.end();
  });

const { data } = await send(null);
console.log(data);

Python

import os
import requests

res = requests.get(
    "https://api.leadx.in/api/key/protected/custom-section?p=1&n=25",
    headers={"apikey": os.environ["LEADX_API_KEY"]},
    timeout=30,
)

payload = res.json()
res.raise_for_status()
print(payload["data"])

PHP

<?php
$ch = curl_init('https://api.leadx.in/api/key/protected/custom-section?p=1&n=25');
curl_setopt_array($ch, [
    CURLOPT_CUSTOMREQUEST  => 'GET',
    CURLOPT_RETURNTRANSFER => true,
    CURLOPT_HTTPHEADER     => [
        'apikey: ' . getenv('LEADX_API_KEY'),
    ],
]);

$response = curl_exec($ch);
$status = curl_getinfo($ch, CURLINFO_HTTP_CODE);
curl_close($ch);

$payload = json_decode($response, true);
if ($status >= 400) {
    throw new RuntimeException("$status {$payload['message']}");
}

print_r($payload['data']);

POST /custom-section

Create custom section.

Auth apikey · Success 200

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

Request body

Field	Type	Required	Default	Notes
name	string	yes	—
panel	string	yes	—	lead, contact or productService.
description	string		—
order	number		—
hide	boolean		—

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

cURL

curl -X POST 'https://api.leadx.in/api/key/protected/custom-section' \
  -H 'apikey: $LEADX_API_KEY' \
  -H 'Content-Type: application/json' \
  -d '{
  "name": "",
  "panel": "",
  "description": "",
  "order": "",
  "hide": ""
}'

fetch

// Node 18+ and every modern browser ship fetch.
const res = await fetch('https://api.leadx.in/api/key/protected/custom-section', {
  method: 'POST',
  headers: {
    apikey: process.env.LEADX_API_KEY,
    'Content-Type': 'application/json',
  },
  body: JSON.stringify({
    "name": "",
    "panel": "",
    "description": "",
    "order": "",
    "hide": ""
  }),
});

const payload = await res.json();
if (!res.ok) {
  // Errors carry { status, success, message } — not the success envelope.
  throw new Error(`${res.status} ${payload.message}`);
}

console.log(payload.data);

axios

import axios from 'axios';

const leadx = axios.create({
  baseURL: 'https://api.leadx.in/api/key/protected',
  headers: { apikey: process.env.LEADX_API_KEY },
});

try {
  const { data } = await leadx.post(
    '/custom-section',
    {
      "name": "",
      "panel": "",
      "description": "",
      "order": "",
      "hide": ""
    }
  );
  console.log(data.data);
} catch (err) {
  // axios throws on 4xx/5xx; the envelope is on err.response.data.
  throw new Error(`${err.response?.status} ${err.response?.data?.message ?? err.message}`);
}

Node (no deps)

import { request } from 'node:https';

// The dependency-free version, for somewhere fetch is not available.
const send = (payload) =>
  new Promise((resolve, reject) => {
    const req = request(
      'https://api.leadx.in/api/key/protected/custom-section',
      {
        method: 'POST',
        headers: {
          apikey: process.env.LEADX_API_KEY,
          'Content-Type': 'application/json',
        },
      },
      (res) => {
        let raw = '';
        res.on('data', (chunk) => { raw += chunk; });
        res.on('end', () => {
          const body = JSON.parse(raw);
          if (res.statusCode >= 400) reject(new Error(`${res.statusCode} ${body.message}`));
          else resolve(body);
        });
      },
    );
    req.on('error', reject);
    req.write(JSON.stringify(payload));
    req.end();
  });

const { data } = await send({
  "name": "",
  "panel": "",
  "description": "",
  "order": "",
  "hide": ""
});
console.log(data);

Python

import os
import requests

res = requests.post(
    "https://api.leadx.in/api/key/protected/custom-section",
    headers={"apikey": os.environ["LEADX_API_KEY"]},
    json={
        "name": "",
        "panel": "",
        "description": "",
        "order": "",
        "hide": ""
    },
    timeout=30,
)

payload = res.json()
res.raise_for_status()
print(payload["data"])

PHP

<?php
$ch = curl_init('https://api.leadx.in/api/key/protected/custom-section');
curl_setopt_array($ch, [
    CURLOPT_CUSTOMREQUEST  => 'POST',
    CURLOPT_RETURNTRANSFER => true,
    CURLOPT_HTTPHEADER     => [
        'apikey: ' . getenv('LEADX_API_KEY'),
        'Content-Type: application/json',
    ],
    CURLOPT_POSTFIELDS     => json_encode({
      'name': '',
      'panel': '',
      'description': '',
      'order': '',
      'hide': ''
    }),
]);

$response = curl_exec($ch);
$status = curl_getinfo($ch, CURLINFO_HTTP_CODE);
curl_close($ch);

$payload = json_decode($response, true);
if ($status >= 400) {
    throw new RuntimeException("$status {$payload['message']}");
}

print_r($payload['data']);

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	Type	Default	Notes
ids	array	[]	Documents to act on.
nids	array	[]	Documents to exclude.
selectAll	boolean	false	Act on everything matching the query-string filter instead of an id list.
filters	object	{}

Response — data is null; the outcome is the status code and message.

cURL

curl -X DELETE 'https://api.leadx.in/api/key/protected/custom-section' \
  -H 'apikey: $LEADX_API_KEY' \
  -H 'Content-Type: application/json' \
  -d '{
  "ids": [],
  "nids": [],
  "selectAll": false,
  "filters": {}
}'

fetch

// Node 18+ and every modern browser ship fetch.
const res = await fetch('https://api.leadx.in/api/key/protected/custom-section', {
  method: 'DELETE',
  headers: {
    apikey: process.env.LEADX_API_KEY,
    'Content-Type': 'application/json',
  },
  body: JSON.stringify({
    "ids": [],
    "nids": [],
    "selectAll": false,
    "filters": {}
  }),
});

const payload = await res.json();
if (!res.ok) {
  // Errors carry { status, success, message } — not the success envelope.
  throw new Error(`${res.status} ${payload.message}`);
}

console.log(payload.data);

axios

import axios from 'axios';

const leadx = axios.create({
  baseURL: 'https://api.leadx.in/api/key/protected',
  headers: { apikey: process.env.LEADX_API_KEY },
});

try {
  const { data } = await leadx.delete(
    '/custom-section',
    {
      "ids": [],
      "nids": [],
      "selectAll": false,
      "filters": {}
    }
  );
  console.log(data.data);
} catch (err) {
  // axios throws on 4xx/5xx; the envelope is on err.response.data.
  throw new Error(`${err.response?.status} ${err.response?.data?.message ?? err.message}`);
}

Node (no deps)

import { request } from 'node:https';

// The dependency-free version, for somewhere fetch is not available.
const send = (payload) =>
  new Promise((resolve, reject) => {
    const req = request(
      'https://api.leadx.in/api/key/protected/custom-section',
      {
        method: 'DELETE',
        headers: {
          apikey: process.env.LEADX_API_KEY,
          'Content-Type': 'application/json',
        },
      },
      (res) => {
        let raw = '';
        res.on('data', (chunk) => { raw += chunk; });
        res.on('end', () => {
          const body = JSON.parse(raw);
          if (res.statusCode >= 400) reject(new Error(`${res.statusCode} ${body.message}`));
          else resolve(body);
        });
      },
    );
    req.on('error', reject);
    req.write(JSON.stringify(payload));
    req.end();
  });

const { data } = await send({
  "ids": [],
  "nids": [],
  "selectAll": false,
  "filters": {}
});
console.log(data);

Python

import os
import requests

res = requests.delete(
    "https://api.leadx.in/api/key/protected/custom-section",
    headers={"apikey": os.environ["LEADX_API_KEY"]},
    json={
        "ids": [],
        "nids": [],
        "selectAll": False,
        "filters": {}
    },
    timeout=30,
)

payload = res.json()
res.raise_for_status()
print(payload["data"])

PHP

<?php
$ch = curl_init('https://api.leadx.in/api/key/protected/custom-section');
curl_setopt_array($ch, [
    CURLOPT_CUSTOMREQUEST  => 'DELETE',
    CURLOPT_RETURNTRANSFER => true,
    CURLOPT_HTTPHEADER     => [
        'apikey: ' . getenv('LEADX_API_KEY'),
        'Content-Type: application/json',
    ],
    CURLOPT_POSTFIELDS     => json_encode({
      'ids': [],
      'nids': [],
      'selectAll': false,
      'filters': {}
    }),
]);

$response = curl_exec($ch);
$status = curl_getinfo($ch, CURLINFO_HTTP_CODE);
curl_close($ch);

$payload = json_decode($response, true);
if ($status >= 400) {
    throw new RuntimeException("$status {$payload['message']}");
}

print_r($payload['data']);

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.

cURL

curl -X GET 'https://api.leadx.in/api/key/protected/custom-section/CUSTOM_SECTION_ID' \
  -H 'apikey: $LEADX_API_KEY'

fetch

// Node 18+ and every modern browser ship fetch.
const res = await fetch('https://api.leadx.in/api/key/protected/custom-section/CUSTOM_SECTION_ID', {
  method: 'GET',
  headers: {
    apikey: process.env.LEADX_API_KEY,
  },
});

const payload = await res.json();
if (!res.ok) {
  // Errors carry { status, success, message } — not the success envelope.
  throw new Error(`${res.status} ${payload.message}`);
}

console.log(payload.data);

axios

import axios from 'axios';

const leadx = axios.create({
  baseURL: 'https://api.leadx.in/api/key/protected',
  headers: { apikey: process.env.LEADX_API_KEY },
});

try {
  const { data } = await leadx.get(
    '/custom-section/CUSTOM_SECTION_ID'
  );
  console.log(data.data);
} catch (err) {
  // axios throws on 4xx/5xx; the envelope is on err.response.data.
  throw new Error(`${err.response?.status} ${err.response?.data?.message ?? err.message}`);
}

Node (no deps)

import { request } from 'node:https';

// The dependency-free version, for somewhere fetch is not available.
const send = (payload) =>
  new Promise((resolve, reject) => {
    const req = request(
      'https://api.leadx.in/api/key/protected/custom-section/CUSTOM_SECTION_ID',
      {
        method: 'GET',
        headers: {
          apikey: process.env.LEADX_API_KEY,
        },
      },
      (res) => {
        let raw = '';
        res.on('data', (chunk) => { raw += chunk; });
        res.on('end', () => {
          const body = JSON.parse(raw);
          if (res.statusCode >= 400) reject(new Error(`${res.statusCode} ${body.message}`));
          else resolve(body);
        });
      },
    );
    req.on('error', reject);
    
    req.end();
  });

const { data } = await send(null);
console.log(data);

Python

import os
import requests

res = requests.get(
    "https://api.leadx.in/api/key/protected/custom-section/CUSTOM_SECTION_ID",
    headers={"apikey": os.environ["LEADX_API_KEY"]},
    timeout=30,
)

payload = res.json()
res.raise_for_status()
print(payload["data"])

PHP

<?php
$ch = curl_init('https://api.leadx.in/api/key/protected/custom-section/CUSTOM_SECTION_ID');
curl_setopt_array($ch, [
    CURLOPT_CUSTOMREQUEST  => 'GET',
    CURLOPT_RETURNTRANSFER => true,
    CURLOPT_HTTPHEADER     => [
        'apikey: ' . getenv('LEADX_API_KEY'),
    ],
]);

$response = curl_exec($ch);
$status = curl_getinfo($ch, CURLINFO_HTTP_CODE);
curl_close($ch);

$payload = json_decode($response, true);
if ($status >= 400) {
    throw new RuntimeException("$status {$payload['message']}");
}

print_r($payload['data']);

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	Type	Default	Notes
panel	string	—	lead, contact or productService.

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

cURL

curl -X PUT 'https://api.leadx.in/api/key/protected/custom-section/CUSTOM_SECTION_ID' \
  -H 'apikey: $LEADX_API_KEY' \
  -H 'Content-Type: application/json' \
  -d '{
  "panel": ""
}'

fetch

// Node 18+ and every modern browser ship fetch.
const res = await fetch('https://api.leadx.in/api/key/protected/custom-section/CUSTOM_SECTION_ID', {
  method: 'PUT',
  headers: {
    apikey: process.env.LEADX_API_KEY,
    'Content-Type': 'application/json',
  },
  body: JSON.stringify({
    "panel": ""
  }),
});

const payload = await res.json();
if (!res.ok) {
  // Errors carry { status, success, message } — not the success envelope.
  throw new Error(`${res.status} ${payload.message}`);
}

console.log(payload.data);

axios

import axios from 'axios';

const leadx = axios.create({
  baseURL: 'https://api.leadx.in/api/key/protected',
  headers: { apikey: process.env.LEADX_API_KEY },
});

try {
  const { data } = await leadx.put(
    '/custom-section/CUSTOM_SECTION_ID',
    {
      "panel": ""
    }
  );
  console.log(data.data);
} catch (err) {
  // axios throws on 4xx/5xx; the envelope is on err.response.data.
  throw new Error(`${err.response?.status} ${err.response?.data?.message ?? err.message}`);
}

Node (no deps)

import { request } from 'node:https';

// The dependency-free version, for somewhere fetch is not available.
const send = (payload) =>
  new Promise((resolve, reject) => {
    const req = request(
      'https://api.leadx.in/api/key/protected/custom-section/CUSTOM_SECTION_ID',
      {
        method: 'PUT',
        headers: {
          apikey: process.env.LEADX_API_KEY,
          'Content-Type': 'application/json',
        },
      },
      (res) => {
        let raw = '';
        res.on('data', (chunk) => { raw += chunk; });
        res.on('end', () => {
          const body = JSON.parse(raw);
          if (res.statusCode >= 400) reject(new Error(`${res.statusCode} ${body.message}`));
          else resolve(body);
        });
      },
    );
    req.on('error', reject);
    req.write(JSON.stringify(payload));
    req.end();
  });

const { data } = await send({
  "panel": ""
});
console.log(data);

Python

import os
import requests

res = requests.put(
    "https://api.leadx.in/api/key/protected/custom-section/CUSTOM_SECTION_ID",
    headers={"apikey": os.environ["LEADX_API_KEY"]},
    json={
        "panel": ""
    },
    timeout=30,
)

payload = res.json()
res.raise_for_status()
print(payload["data"])

PHP

<?php
$ch = curl_init('https://api.leadx.in/api/key/protected/custom-section/CUSTOM_SECTION_ID');
curl_setopt_array($ch, [
    CURLOPT_CUSTOMREQUEST  => 'PUT',
    CURLOPT_RETURNTRANSFER => true,
    CURLOPT_HTTPHEADER     => [
        'apikey: ' . getenv('LEADX_API_KEY'),
        'Content-Type: application/json',
    ],
    CURLOPT_POSTFIELDS     => json_encode({
      'panel': ''
    }),
]);

$response = curl_exec($ch);
$status = curl_getinfo($ch, CURLINFO_HTTP_CODE);
curl_close($ch);

$payload = json_decode($response, true);
if ($status >= 400) {
    throw new RuntimeException("$status {$payload['message']}");
}

print_r($payload['data']);

Errors CustomSectionNotFound_400

PUT /custom-section/reorder

Reorder sections.

Auth apikey

Request body

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

Response — data is null; the outcome is the status code and message.

cURL

curl -X PUT 'https://api.leadx.in/api/key/protected/custom-section/reorder' \
  -H 'apikey: $LEADX_API_KEY' \
  -H 'Content-Type: application/json' \
  -d '{
  "sections": [],
  "panel": ""
}'

fetch

// Node 18+ and every modern browser ship fetch.
const res = await fetch('https://api.leadx.in/api/key/protected/custom-section/reorder', {
  method: 'PUT',
  headers: {
    apikey: process.env.LEADX_API_KEY,
    'Content-Type': 'application/json',
  },
  body: JSON.stringify({
    "sections": [],
    "panel": ""
  }),
});

const payload = await res.json();
if (!res.ok) {
  // Errors carry { status, success, message } — not the success envelope.
  throw new Error(`${res.status} ${payload.message}`);
}

console.log(payload.data);

axios

import axios from 'axios';

const leadx = axios.create({
  baseURL: 'https://api.leadx.in/api/key/protected',
  headers: { apikey: process.env.LEADX_API_KEY },
});

try {
  const { data } = await leadx.put(
    '/custom-section/reorder',
    {
      "sections": [],
      "panel": ""
    }
  );
  console.log(data.data);
} catch (err) {
  // axios throws on 4xx/5xx; the envelope is on err.response.data.
  throw new Error(`${err.response?.status} ${err.response?.data?.message ?? err.message}`);
}

Node (no deps)

import { request } from 'node:https';

// The dependency-free version, for somewhere fetch is not available.
const send = (payload) =>
  new Promise((resolve, reject) => {
    const req = request(
      'https://api.leadx.in/api/key/protected/custom-section/reorder',
      {
        method: 'PUT',
        headers: {
          apikey: process.env.LEADX_API_KEY,
          'Content-Type': 'application/json',
        },
      },
      (res) => {
        let raw = '';
        res.on('data', (chunk) => { raw += chunk; });
        res.on('end', () => {
          const body = JSON.parse(raw);
          if (res.statusCode >= 400) reject(new Error(`${res.statusCode} ${body.message}`));
          else resolve(body);
        });
      },
    );
    req.on('error', reject);
    req.write(JSON.stringify(payload));
    req.end();
  });

const { data } = await send({
  "sections": [],
  "panel": ""
});
console.log(data);

Python

import os
import requests

res = requests.put(
    "https://api.leadx.in/api/key/protected/custom-section/reorder",
    headers={"apikey": os.environ["LEADX_API_KEY"]},
    json={
        "sections": [],
        "panel": ""
    },
    timeout=30,
)

payload = res.json()
res.raise_for_status()
print(payload["data"])

PHP

<?php
$ch = curl_init('https://api.leadx.in/api/key/protected/custom-section/reorder');
curl_setopt_array($ch, [
    CURLOPT_CUSTOMREQUEST  => 'PUT',
    CURLOPT_RETURNTRANSFER => true,
    CURLOPT_HTTPHEADER     => [
        'apikey: ' . getenv('LEADX_API_KEY'),
        'Content-Type: application/json',
    ],
    CURLOPT_POSTFIELDS     => json_encode({
      'sections': [],
      'panel': ''
    }),
]);

$response = curl_exec($ch);
$status = curl_getinfo($ch, CURLINFO_HTTP_CODE);
curl_close($ch);

$payload = json_decode($response, true);
if ($status >= 400) {
    throw new RuntimeException("$status {$payload['message']}");
}

print_r($payload['data']);