Delete Sub Organization

Deletes a sub organization

POST

/

public

/

v1

/

submit

/

delete_sub_organization

Authorizations

API Key

X-Stamp

string

header

required

X-Stamp

string

header

required

X-Stamp-Webauthn

string

header

required

Body

type · enum<string> · required

Enum options: ACTIVITY_TYPE_DELETE_SUB_ORGANIZATION

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

boolean

Sub-organization deletion, by default, requires associated wallets and private keys to be exported for security reasons. Set this boolean to true to force sub-organization deletion even if some wallets or private keys within it have not been exported yet. Default: false.

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

object

required

The deleteSubOrganizationIntent object

Show deleteSubOrganizationIntent details

activity.intent.deleteSubOrganizationIntent.deleteWithoutExport

boolean

Sub-organization deletion, by default, requires associated wallets and private keys to be exported for security reasons. Set this boolean to true to force sub-organization deletion even if some wallets or private keys within it have not been exported yet. Default: false.

activity.result

object

required

The result of the activity

Show result details

activity.result.deleteSubOrganizationResult

object

required

The deleteSubOrganizationResult object

Show deleteSubOrganizationResult details

activity.result.deleteSubOrganizationResult.subOrganizationUuid

string

required

Unique identifier of the sub organization that was removed

cURL

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

200

{
  "activity": {
    "id": "<activity-id>",
    "status": "ACTIVITY_STATUS_COMPLETED",
    "type": "ACTIVITY_TYPE_DELETE_SUB_ORGANIZATION",
    "organizationId": "<organization-id>",
    "timestampMs": "<timestamp> (e.g. 1746736509954)",
    "result": {
      "activity": {
        "type": "<string>",
        "intent": {
          "deleteSubOrganizationIntent": {
            "deleteWithoutExport": true
          }
        },
        "result": {
          "deleteSubOrganizationResult": {
            "subOrganizationUuid": "<string>"
          }
        }
      }
    }
  }
}