Update Private Key Tag

Update human-readable name or associated private keys. Note that this activity is atomic: all of the updates will succeed at once, or all of them will fail.

type · enum<string> · required

Enum options: ACTIVITY_TYPE_UPDATE_PRIVATE_KEY_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.addPrivateKeyIds · array · required

A list of Private Keys IDs to add this tag to.

Show item details

Array item type: string

item field

parameters.removePrivateKeyIds · array · required

A list of Private Key IDs to remove this tag from.

Show item details

Array item type: string

item field

A successful response returns the following fields:

activity · object · required

The activity object containing type, intent, and result

Show activity details

cURL

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

200

{
  "activity": {
    "id": "<activity-id>",
    "status": "ACTIVITY_STATUS_COMPLETED",
    "type": "ACTIVITY_TYPE_UPDATE_PRIVATE_KEY_TAG",
    "organizationId": "<organization-id>",
    "timestampMs": "<timestamp> (e.g. 1746736509954)",
    "result": {
      "activity": {
        "type": "<string>",
        "intent": {
          "updatePrivateKeyTagIntent": {
            "privateKeyTagId": "<string>",
            "newPrivateKeyTagName": "<string>",
            "addPrivateKeyIds": [
              "<string_element>"
            ],
            "removePrivateKeyIds": [
              "<string_element>"
            ]
          }
        },
        "result": {
          "updatePrivateKeyTagResult": {
            "privateKeyTagId": "<string>"
          }
        }
      }
    }
  }
}