Skip to main content
PUT
/
tags
/
{id}
Update a business lead segmentation tag
curl --request PUT \
  --url https://api.leadping.ai/tags/{id} \
  --header 'Content-Type: application/json' \
  --data '
{
  "name": "<string>",
  "color": "<string>",
  "description": "<string>",
  "id": "<string>"
}
'
{
  "businessId": "<string>",
  "name": "<string>",
  "normalizedName": "<string>",
  "color": "<string>",
  "description": "<string>",
  "createdByUserId": "<string>",
  "isArchived": true,
  "archivedAt": "2023-11-07T05:31:56Z",
  "id": "<string>",
  "createdAt": "2023-11-07T05:31:56Z",
  "modifiedAt": "2023-11-07T05:31:56Z"
}

Path Parameters

​
id
string
required

Body

Request payload for creating or updating a business tag.

​
name
string | null

The business-facing tag name.

​
color
string | null

Optional palette token used for compact tag display.

​
description
string | null

Optional internal description for the tag.

​
id
string | null

The unique identifier for the entity, when updating an existing entity.

Response

OK

API response containing business tag data.

​
businessId
string | null
​
name
string
​
normalizedName
string
​
color
string | null
​
description
string | null
​
createdByUserId
string | null
​
isArchived
boolean
​
archivedAt
string<date-time> | null
​
id
string

The unique identifier for the entity.

​
createdAt
string<date-time>

The date and time when the entity was created.

​
modifiedAt
string<date-time> | null

The date and time when the entity was last modified, if applicable.