Skip to main content
POST
/
public
/
v1
/
submit
/
create_user_tag

Authorizations

  • API Key
  • Webauthn (Passkey)
X-Stamp
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

Response

A successful response returns the following fields:
​
activity
object
required
The activity object containing type, intent, and result
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>"
            ]
          }
        }
      }
    }
  }
}