Create User Tag

Create a user tag and add it to users.

POST

/

public

/

v1

/

submit

/

create_user_tag

Authorizations

API Key

X-Stamp

string

header

required

Webauthn (Passkey)

X-Stamp-Webauthn

string

header

required

Body

type · enum<string> · required

Enum options: ACTIVITY_TYPE_CREATE_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.userTagName

string

required

Human-readable name for a User Tag.

parameters.userIds · array · required

A list of User IDs.

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.createUserTagIntent

object

required

The createUserTagIntent object

Show createUserTagIntent details

activity.intent.createUserTagIntent.userTagName

string

required

Human-readable name for a User Tag.

activity.intent.createUserTagIntent.userIds

array

required

A list of User IDs.

Show userIds details

activity.intent.createUserTagIntent.userIds.item

string

required

item field

activity.result

object

required

The result of the activity

Show result details

activity.result.createUserTagResult

object

required

The createUserTagResult object

Show createUserTagResult details

activity.result.createUserTagResult.userTagId

string

required

Unique identifier for a given User Tag.

activity.result.createUserTagResult.userIds

array

required

A list of User IDs.

Show userIds details

activity.result.createUserTagResult.userIds.item

string

required

item field

cURL

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>"
        ]
    }
}'

200

{
  "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>"
            ]
          }
        }
      }
    }
  }
}