Authorizations
API Key
WebAuthn (Passkey)
Cryptographically signed (stamped) request to be passed in as a header. For more info, see
here.
Body
Enum options: ACTIVITY_TYPE_UPDATE_USER_TAG
Timestamp (in milliseconds) of the request, used to verify liveness of user requests.
Unique identifier for a given Organization.
The parameters object containing the specific intent data for this activity.
Unique identifier for a given User Tag.
parameters.newUserTagName
The new, human-readable name for the tag with the given ID.
A list of User IDs to add this tag to.
Array item type: string
item field
A list of User IDs to remove this tag from.
Array item type: string
item field
Response
A successful response returns the following fields:
The activity object containing type, intent, and result
Unique identifier for a given Activity object.
Unique identifier for a given Organization.
The intent of the activity
activity.intent.updateUserTagIntent
The updateUserTagIntent objectShow updateUserTagIntent details
activity.intent.updateUserTagIntent.userTagId
Unique identifier for a given User Tag.
activity.intent.updateUserTagIntent.newUserTagName
The new, human-readable name for the tag with the given ID.
activity.intent.updateUserTagIntent.addUserIds
A list of User IDs to add this tag to.
activity.intent.updateUserTagIntent.addUserIds.item
activity.intent.updateUserTagIntent.removeUserIds
A list of User IDs to remove this tag from.Show removeUserIds details
activity.intent.updateUserTagIntent.removeUserIds.item
The result of the activity
activity.result.updateUserTagResult
The updateUserTagResult objectShow updateUserTagResult details
activity.result.updateUserTagResult.userTagId
Unique identifier for a given User Tag.
A list of objects representing a particular User’s approval or rejection of a Consensus request, including all relevant metadata.
An artifact verifying a User’s action.
Whether the activity can be approved.
Whether the activity can be rejected.
The last update timestamp.
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: <string> (see Authorizations)" \
--data '{
"type": "ACTIVITY_TYPE_UPDATE_USER_TAG",
"timestampMs": "<string> (e.g. 1746736509954)",
"organizationId": "<string> (Your Organization ID)",
"parameters": {
"userTagId": "<string>",
"newUserTagName": "<string>",
"addUserIds": [
"<string>"
],
"removeUserIds": [
"<string>"
]
}
}'
{
"activity": {
"id": "<activity-id>",
"status": "ACTIVITY_STATUS_COMPLETED",
"type": "ACTIVITY_TYPE_UPDATE_USER_TAG",
"organizationId": "<organization-id>",
"timestampMs": "<timestamp> (e.g. 1746736509954)",
"result": {
"activity": {
"id": "<string>",
"organizationId": "<string>",
"status": "<string>",
"type": "<string>",
"intent": {
"updateUserTagIntent": {
"userTagId": "<string>",
"newUserTagName": "<string>",
"addUserIds": [
"<string>"
],
"removeUserIds": [
"<string>"
]
}
},
"result": {
"updateUserTagResult": {
"userTagId": "<string>"
}
},
"votes": "<array>",
"fingerprint": "<string>",
"canApprove": "<boolean>",
"canReject": "<boolean>",
"createdAt": "<string>",
"updatedAt": "<string>"
}
}
}
}