Delete Wallets

Deletes wallets for an organization

POST

/

public

/

v1

/

submit

/

delete_wallets

Authorizations

API Key

X-Stamp

string

header

required

Body

type · enum<string> · required

Enum options: ACTIVITY_TYPE_DELETE_WALLETS

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

List of unique identifiers for wallets within an organization

Show item details

Array item type: string

item field

parameters.deleteWithoutExport

boolean

Optional parameter for deleting the wallets, even if any have not been previously exported. If they have been exported, this field is ignored.

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

object

required

The deleteWalletsIntent object

Show deleteWalletsIntent details

activity.intent.deleteWalletsIntent.walletIds

array

required

List of unique identifiers for wallets within an organization

Show walletIds details

activity.intent.deleteWalletsIntent.walletIds.item

string

required

item field

activity.intent.deleteWalletsIntent.deleteWithoutExport

boolean

Optional parameter for deleting the wallets, even if any have not been previously exported. If they have been exported, this field is ignored.

activity.result

object

required

The result of the activity

Show result details

activity.result.deleteWalletsResult

object

required

The deleteWalletsResult object

Show deleteWalletsResult details

activity.result.deleteWalletsResult.walletIds

array

required

A list of wallet unique identifiers that were removed

Show walletIds details

activity.result.deleteWalletsResult.walletIds.item

string

required

item field

cURL

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

200

{
  "activity": {
    "id": "<activity-id>",
    "status": "ACTIVITY_STATUS_COMPLETED",
    "type": "ACTIVITY_TYPE_DELETE_WALLETS",
    "organizationId": "<organization-id>",
    "timestampMs": "<timestamp> (e.g. 1746736509954)",
    "result": {
      "activity": {
        "type": "<string>",
        "intent": {
          "deleteWalletsIntent": {
            "walletIds": [
              "<string_element>"
            ],
            "deleteWithoutExport": true
          }
        },
        "result": {
          "deleteWalletsResult": {
            "walletIds": [
              "<string_element>"
            ]
          }
        }
      }
    }
  }
}