Tags
Base URL https://api.leadx.in/api/key/protected. Every request needs an apikey header — see Authentication.
4 endpoints.
GET /tag
Get all tag.
Auth apikey
:::note Used by the web app
components/CampaignSetup.jsx, components/campaignSetupDesigns/audienceSources.jsx, pages/AddTag.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 Tag objects, alongside the pagination fields described in Response format. updatedBy, createdBy are populated, so they arrive as nested objects rather than ids.
POST /tag
Create tag.
Auth apikey · Success 200
:::note Used by the web app
components/CampaignSetup.jsx, components/campaignSetupDesigns/audienceSources.jsx, pages/AddTag.jsx and 3 more
:::
Request body
| Field | Default |
|---|---|
name | — |
description | — |
Required: name.
Response — data is one Tag object. (Resource deduced from the collections this handler reads, not read off an explicit return.)
Errors TagNameAlreadyExists_400
GET /tag/:id
Get tag.
Auth apikey
:::note Used by the web app
pages/AddTag.jsx
:::
Path parameters
| Name | |
|---|---|
id | Required |
Response — data is one Tag object.
Errors TagNotFound_400
PUT /tag/:id
Update tag.
Auth apikey · Success 200
:::note Used by the web app
pages/AddTag.jsx
:::
Path parameters
| Name | |
|---|---|
id | Required |
Response — data is one Tag object.
Errors TagNotFound_400