Skip to main content
PATCH
/
tag
/
{tagId}
Update tag by ID.
curl --request PATCH \
  --url https://vanguard.profilebehavior.com/api/v4/tag/{tagId} \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "label": "Staff",
  "color": "emerald"
}
'
{
  "code": 200,
  "tag": {
    "label": "Staff",
    "color": "indigo",
    "profiles": [
      "6592008029c8c3e4dc76256c",
      "507f191e810c19729de860ea"
    ]
  },
  "status": "success"
}

Authorizations

​
Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Path Parameters

​
tagId
string
required

The ID of the tag to update.

Body

application/json

The properties to be assigned to the tag.

​
label
string

The text to describe the new tag.

Example:

"Staff"

​
color
enum<string>

The color assigned for visual purposes when displaying the tags.

Available options:
emerald,
red,
yellow,
orange,
blue,
indigo,
purple,
pink,
zinc

Response

Success

Standard response object for successful single-resource requests in the Profile Behavior API. Contains an HTTP status code, the returned resource data, and a status indicator.

​
code
integer<int32>
required

HTTP status code of the successful response.

​
status
enum<string>

Always "success" for successful responses.

Available options:
success
​
tag
object

Represents a tag used for organizing profiles, teams, or groups within an account. Tags allow for flexible grouping, filtering, and analytics across individuals and teams.