Update User Tag

Update human-readable name or associated users. Note that this activity is atomic: all of the updates will succeed at once, or all of them will fail.

POST

/

public

/

v1

/

submit

/

update_user_tag

Authorizations

API Key

X-Stamp

string

header

required

Body

type · enum<string> · required

Enum options: ACTIVITY_TYPE_UPDATE_USER_TAG

timestampMs · string · required

Timestamp (in milliseconds) of the request, used to verify liveness of user requests.

organizationId · string · required

Unique identifier for a given Organization.

parameters · object · required

parameters field

Show details

parameters.userTagId

string

required

Unique identifier for a given User Tag.

parameters.newUserTagName

string

The new, human-readable name for the tag with the given ID.

parameters.addUserIds · array · required

A list of User IDs to add this tag to.

Show item details

Array item type: string

item field

parameters.removeUserIds · array · required

A list of User IDs to remove this tag from.

Show item details

Array item type: string

item field

Response

A successful response returns the following fields:

activity · object · required

The activity object containing type, intent, and result

Show activity details

activity.type

string

required

The activity type

activity.intent

object

required

The intent of the activity

Show intent details

activity.intent.updateUserTagIntent

object

required

The updateUserTagIntent object

Show updateUserTagIntent details

activity.intent.updateUserTagIntent.userTagId

string

required

Unique identifier for a given User Tag.

activity.intent.updateUserTagIntent.newUserTagName

string

The new, human-readable name for the tag with the given ID.

activity.intent.updateUserTagIntent.addUserIds

array

required

A list of User IDs to add this tag to.

Show addUserIds details

activity.intent.updateUserTagIntent.addUserIds.item

string

required

item field

activity.intent.updateUserTagIntent.removeUserIds

array

required

A list of User IDs to remove this tag from.

Show removeUserIds details

activity.intent.updateUserTagIntent.removeUserIds.item

string

required

item field

activity.result

object

required

The result of the activity

Show result details

activity.result.updateUserTagResult

object

required

The updateUserTagResult object

Show updateUserTagResult details

activity.result.updateUserTagResult.userTagId

string

required

Unique identifier for a given User Tag.

cURL

curl --request POST \
  --url https://api.turnkey.com/public/v1/submit/update_user_tag \
  --header 'Accept: application/json' \
  --header 'Content-Type: application/json' \
  --header "X-Stamp: <YOUR_API_KEY.YOUR_API_SECRET>" \
  --data '{
    "type": "ACTIVITY_TYPE_UPDATE_USER_TAG",
    "timestampMs": "<string> (e.g. 1746736509954)",
    "organizationId": "<string> (Your Organization ID)",
    "parameters": {
        "userTagId": "<string>",
        "newUserTagName": "<string>",
        "addUserIds": [
            "<string_element>"
        ],
        "removeUserIds": [
            "<string_element>"
        ]
    }
}'

200

{
  "activity": {
    "id": "<activity-id>",
    "status": "ACTIVITY_STATUS_COMPLETED",
    "type": "ACTIVITY_TYPE_UPDATE_USER_TAG",
    "organizationId": "<organization-id>",
    "timestampMs": "<timestamp> (e.g. 1746736509954)",
    "result": {
      "activity": {
        "type": "<string>",
        "intent": {
          "updateUserTagIntent": {
            "userTagId": "<string>",
            "newUserTagName": "<string>",
            "addUserIds": [
              "<string_element>"
            ],
            "removeUserIds": [
              "<string_element>"
            ]
          }
        },
        "result": {
          "updateUserTagResult": {
            "userTagId": "<string>"
          }
        }
      }
    }
  }
}