Contact categories

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

4 endpoints.

GET /contact-category

Get all contact category.

Auth apikey

:::note Used by the web app components/CampaignSetup.jsx, components/campaignSetupDesigns/audienceSources.jsx, pages/AddCategory.jsx and 3 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 ContactCategory objects, alongside the pagination fields described in Response format. updatedBy, createdBy are populated, so they arrive as nested objects rather than ids.

POST /contact-category

Create contact category.

Auth apikey · Success 200

:::note Used by the web app components/CampaignSetup.jsx, components/campaignSetupDesigns/audienceSources.jsx, pages/AddCategory.jsx and 3 more :::

Request body

Field	Default
name	—
description	—

Required: name.

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

Errors ContactCategoryNameAlreadyExists_400

GET /contact-category/:id

Get contact category.

Auth apikey

:::note Used by the web app pages/AddCategory.jsx :::

Path parameters

Name
id	Required

Response — data is one ContactCategory object.

Errors ContactCategoryNotFound_400

PUT /contact-category/:id

Update contact category.

Auth apikey · Success 200

:::note Used by the web app pages/AddCategory.jsx :::

Path parameters

Name
id	Required

Response — data is one ContactCategory object.

Errors ContactCategoryNotFound_400