Sign in

v1

latestOpenAPI 3.0.12026-07-22120163333.7 KB
Agent User

Add tags to an agent

Attaches one or more tags to the specified agent in batch.

Notes:

  • tagNames must not be empty; up to 20 entries per call.
  • When autoCreate is true, tag names not yet defined on the team are created; when false, unknown tag names cause the call to fail.
  • The response envelope carries data = true and errorCode = 0 on success.
post/v1.0/agent/{agentId}/tag/add

Path parameters

agentIdinteger required

User ID of the agent to tag.

Headers

Authorizationstring required

Bearer [access_token]

Content-Typestring required

application/json

Request body

tagNamesstring[]

Tag names to add to the agent. Up to 20 per call.

autoCreateboolean

When true, tag names that do not yet exist on the team are created automatically. When false, unknown tag names cause the call to fail.

Example request

{
  "tagNames": [
    "VIP",
    "Premium"
  ],
  "autoCreate": true
}

Response

Envelope indicating whether the batch add succeeded.

databoolean

Whether all requested tags were added successfully.

errorCodeinteger

Business error code. 0 indicates success.

errorMsgstring

Human-readable error message when errorCode != 0.

Example response

{
  "data": true
}
All 120 operations