Body
Enum options: ACTIVITY_TYPE_CREATE_USER_TAG
Timestamp (in milliseconds) of the request, used to verify liveness of user requests.
Unique identifier for a given Organization.
parameters field
Human-readable name for a User Tag.
A list of User IDs.
Array item type: string
item field
Response
A successful response returns the following fields:
The activity object containing type, intent, and result
The intent of the activity
activity.intent.createUserTagIntent
The createUserTagIntent objectShow createUserTagIntent details
activity.intent.createUserTagIntent.userTagName
Human-readable name for a User Tag.
activity.intent.createUserTagIntent.userIds
A list of User IDs.
activity.intent.createUserTagIntent.userIds.item
The result of the activity
activity.result.createUserTagResult
The createUserTagResult objectShow createUserTagResult details
activity.result.createUserTagResult.userTagId
Unique identifier for a given User Tag.
activity.result.createUserTagResult.userIds
A list of User IDs.
activity.result.createUserTagResult.userIds.item
curl --request POST \
--url https://api.turnkey.com/public/v1/submit/create_user_tag \
--header 'Accept: application/json' \
--header 'Content-Type: application/json' \
--header "X-Stamp: <YOUR_API_KEY.YOUR_API_SECRET>" \
--data '{
"type": "ACTIVITY_TYPE_CREATE_USER_TAG",
"timestampMs": "<string> (e.g. 1746736509954)",
"organizationId": "<string> (Your Organization ID)",
"parameters": {
"userTagName": "<string>",
"userIds": [
"<string_element>"
]
}
}'
{
"activity": {
"id": "<activity-id>",
"status": "ACTIVITY_STATUS_COMPLETED",
"type": "ACTIVITY_TYPE_CREATE_USER_TAG",
"organizationId": "<organization-id>",
"timestampMs": "<timestamp> (e.g. 1746736509954)",
"result": {
"activity": {
"type": "<string>",
"intent": {
"createUserTagIntent": {
"userTagName": "<string>",
"userIds": [
"<string_element>"
]
}
},
"result": {
"createUserTagResult": {
"userTagId": "<string>",
"userIds": [
"<string_element>"
]
}
}
}
}
}
}