Delete User Tags

Delete User Tags within an Organization

POST

/

public

/

v1

/

submit

/

delete_user_tags

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_DELETE_USER_TAGS

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.userTagIds · array · required

A list of User Tag 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.deleteUserTagsIntent

object

required

The deleteUserTagsIntent object

Show deleteUserTagsIntent details

activity.intent.deleteUserTagsIntent.userTagIds

array

required

A list of User Tag IDs.

Show userTagIds details

activity.intent.deleteUserTagsIntent.userTagIds.item

string

required

item field

activity.result

object

required

The result of the activity

Show result details

activity.result.deleteUserTagsResult

object

required

The deleteUserTagsResult object

Show deleteUserTagsResult details

activity.result.deleteUserTagsResult.userTagIds

array

required

A list of User Tag IDs.

Show userTagIds details

activity.result.deleteUserTagsResult.userTagIds.item

string

required

item field

activity.result.deleteUserTagsResult.userIds

array

required

A list of User IDs.

Show userIds details

activity.result.deleteUserTagsResult.userIds.item

string

required

item field

cURL

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

200

{
  "activity": {
    "id": "<activity-id>",
    "status": "ACTIVITY_STATUS_COMPLETED",
    "type": "ACTIVITY_TYPE_DELETE_USER_TAGS",
    "organizationId": "<organization-id>",
    "timestampMs": "<timestamp> (e.g. 1746736509954)",
    "result": {
      "activity": {
        "type": "<string>",
        "intent": {
          "deleteUserTagsIntent": {
            "userTagIds": [
              "<string_element>"
            ]
          }
        },
        "result": {
          "deleteUserTagsResult": {
            "userTagIds": [
              "<string_element>"
            ],
            "userIds": [
              "<string_element>"
            ]
          }
        }
      }
    }
  }
}