Custom fields

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

8 endpoints.

GET /custom-field

Get all custom field.

Auth apikey

:::note Used by the web app components/CampaignSetup.jsx, components/CustomField.jsx, components/CustomFieldsBasedForm.jsx and 9 more :::

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 CustomField 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-field?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-field?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-field?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-field?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-field?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-field?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']);

Errors InvalidPanel_400

POST /custom-field

Create custom field.

Auth apikey · Success 200

:::note Used by the web app components/CampaignSetup.jsx, components/CustomField.jsx, components/CustomFieldsBasedForm.jsx and 9 more :::

Request body

Field	Type	Required	Default	Notes
name	string	yes	—
section	any		—
order	number		—
description	string		—
valueType	string		—
fieldType	string		—
required	boolean		—
hide	boolean		—
allowMultiple			—
placeholder	string		—
helpText			—
defaultValue	any		—
children	object[]		—
options	object[]		—
panel	string	yes	—	lead, contact or productService.

Required: name, type, panel. Of these, type is nested inside another field (commonly formData), or checked under a different internal name.

Response — data is one CustomField 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-field' \
  -H 'apikey: $LEADX_API_KEY' \
  -H 'Content-Type: application/json' \
  -d '{
  "name": "",
  "section": "",
  "order": "",
  "description": "",
  "valueType": "",
  "fieldType": "",
  "required": "",
  "hide": "",
  "allowMultiple": "",
  "placeholder": "",
  "helpText": "",
  "defaultValue": "",
  "children": "",
  "options": "",
  "panel": ""
}'

fetch

// Node 18+ and every modern browser ship fetch.
const res = await fetch('https://api.leadx.in/api/key/protected/custom-field', {
  method: 'POST',
  headers: {
    apikey: process.env.LEADX_API_KEY,
    'Content-Type': 'application/json',
  },
  body: JSON.stringify({
    "name": "",
    "section": "",
    "order": "",
    "description": "",
    "valueType": "",
    "fieldType": "",
    "required": "",
    "hide": "",
    "allowMultiple": "",
    "placeholder": "",
    "helpText": "",
    "defaultValue": "",
    "children": "",
    "options": "",
    "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.post(
    '/custom-field',
    {
      "name": "",
      "section": "",
      "order": "",
      "description": "",
      "valueType": "",
      "fieldType": "",
      "required": "",
      "hide": "",
      "allowMultiple": "",
      "placeholder": "",
      "helpText": "",
      "defaultValue": "",
      "children": "",
      "options": "",
      "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-field',
      {
        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": "",
  "section": "",
  "order": "",
  "description": "",
  "valueType": "",
  "fieldType": "",
  "required": "",
  "hide": "",
  "allowMultiple": "",
  "placeholder": "",
  "helpText": "",
  "defaultValue": "",
  "children": "",
  "options": "",
  "panel": ""
});
console.log(data);

Python

import os
import requests

res = requests.post(
    "https://api.leadx.in/api/key/protected/custom-field",
    headers={"apikey": os.environ["LEADX_API_KEY"]},
    json={
        "name": "",
        "section": "",
        "order": "",
        "description": "",
        "valueType": "",
        "fieldType": "",
        "required": "",
        "hide": "",
        "allowMultiple": "",
        "placeholder": "",
        "helpText": "",
        "defaultValue": "",
        "children": "",
        "options": "",
        "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-field');
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': '',
      'section': '',
      'order': '',
      'description': '',
      'valueType': '',
      'fieldType': '',
      'required': '',
      'hide': '',
      'allowMultiple': '',
      'placeholder': '',
      'helpText': '',
      'defaultValue': '',
      'children': '',
      'options': '',
      '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 CustomFieldNameAlreadyExists_400

DELETE /custom-field

Delete custom field.

Auth apikey · Success 200

:::note Used by the web app components/CampaignSetup.jsx, components/CustomField.jsx, components/CustomFieldsBasedForm.jsx and 9 more :::

Request body — the standard bulk selection: ids, nids, selectAll. Query-string filters apply when selectAll is set.

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

cURL

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

fetch

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

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-field',
    {
      "ids": [
        "RESOURCE_ID"
      ],
      "selectAll": false
    }
  );
  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-field',
      {
        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": [
    "RESOURCE_ID"
  ],
  "selectAll": false
});
console.log(data);

Python

import os
import requests

res = requests.delete(
    "https://api.leadx.in/api/key/protected/custom-field",
    headers={"apikey": os.environ["LEADX_API_KEY"]},
    json={
        "ids": [
            "RESOURCE_ID"
        ],
        "selectAll": False
    },
    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-field');
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': [
        'RESOURCE_ID'
      ],
      'selectAll': false
    }),
]);

$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']);

GET /custom-field/:id

Get custom field.

Auth apikey

:::note Used by the web app components/CustomField.jsx, components/CustomFieldsBasedForm.jsx, components/DependentFieldValueInput.jsx and 3 more :::

Path parameters

Name
id	Required

Response — data is one CustomField object.

cURL

curl -X GET 'https://api.leadx.in/api/key/protected/custom-field/CUSTOM_FIELD_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-field/CUSTOM_FIELD_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-field/CUSTOM_FIELD_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-field/CUSTOM_FIELD_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-field/CUSTOM_FIELD_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-field/CUSTOM_FIELD_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 CustomFieldNotFound_400

PUT /custom-field/:id

Update custom field.

Auth apikey · Success 200

:::note Used by the web app components/CustomField.jsx, components/CustomFieldsBasedForm.jsx, components/DependentFieldValueInput.jsx and 3 more :::

Path parameters

Name
id	Required

Request body

Field	Type	Required	Default	Notes
panel	string	yes	—	lead, contact or productService.
section	any		—

Required: id, panel. Of these, id is nested inside another field (commonly formData), or checked under a different internal name.

Response — data is one CustomField 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-field/CUSTOM_FIELD_ID' \
  -H 'apikey: $LEADX_API_KEY' \
  -H 'Content-Type: application/json' \
  -d '{
  "panel": "",
  "section": ""
}'

fetch

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

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-field/CUSTOM_FIELD_ID',
    {
      "panel": "",
      "section": ""
    }
  );
  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-field/CUSTOM_FIELD_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": "",
  "section": ""
});
console.log(data);

Python

import os
import requests

res = requests.put(
    "https://api.leadx.in/api/key/protected/custom-field/CUSTOM_FIELD_ID",
    headers={"apikey": os.environ["LEADX_API_KEY"]},
    json={
        "panel": "",
        "section": ""
    },
    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-field/CUSTOM_FIELD_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': '',
      'section': ''
    }),
]);

$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 CustomFieldNotFound_400 · InvalidSectionId_400

PUT /custom-field/modify

Modify fields.

Auth apikey

Query parameters

Field	Type	Default
segmentFields	boolean	false
onlyShowTable	boolean	false

Request body

Field	Type	Required	Default	Notes
panel	string	yes	—	lead, contact or productService.
formData			—	System and custom fields together — see Custom fields.
type	string		all

Response — data is one CustomField 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-field/modify' \
  -H 'apikey: $LEADX_API_KEY' \
  -H 'Content-Type: application/json' \
  -d '{
  "panel": "",
  "formData": "",
  "type": "all"
}'

fetch

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

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-field/modify',
    {
      "panel": "",
      "formData": "",
      "type": "all"
    }
  );
  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-field/modify',
      {
        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": "",
  "formData": "",
  "type": "all"
});
console.log(data);

Python

import os
import requests

res = requests.put(
    "https://api.leadx.in/api/key/protected/custom-field/modify",
    headers={"apikey": os.environ["LEADX_API_KEY"]},
    json={
        "panel": "",
        "formData": "",
        "type": "all"
    },
    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-field/modify');
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': '',
      'formData': '',
      'type': 'all'
    }),
]);

$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 CountryNotFound_400 · StateNotFound_400

PUT /custom-field/reorder

Reorder fields.

Auth apikey

Request body

Field	Type	Default	Notes
fields	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-field/reorder' \
  -H 'apikey: $LEADX_API_KEY' \
  -H 'Content-Type: application/json' \
  -d '{
  "fields": [],
  "panel": ""
}'

fetch

// Node 18+ and every modern browser ship fetch.
const res = await fetch('https://api.leadx.in/api/key/protected/custom-field/reorder', {
  method: 'PUT',
  headers: {
    apikey: process.env.LEADX_API_KEY,
    'Content-Type': 'application/json',
  },
  body: JSON.stringify({
    "fields": [],
    "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-field/reorder',
    {
      "fields": [],
      "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-field/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({
  "fields": [],
  "panel": ""
});
console.log(data);

Python

import os
import requests

res = requests.put(
    "https://api.leadx.in/api/key/protected/custom-field/reorder",
    headers={"apikey": os.environ["LEADX_API_KEY"]},
    json={
        "fields": [],
        "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-field/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({
      'fields': [],
      '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']);

PUT /custom-field/reset-system

Reset system fields.

Auth apikey · Success 200

Request body

Field	Required	Default	Notes
panel	yes	—	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-field/reset-system' \
  -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-field/reset-system', {
  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-field/reset-system',
    {
      "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-field/reset-system',
      {
        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-field/reset-system",
    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-field/reset-system');
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 InvalidPanel_400