DEL

Delete a Link account

Soft-deletes a Link account. Blocks deletion if the account has active sub-accounts or pending transfers. To delete all sub-accounts together with the main account in one atomic operation, set the optional deleteAllSubAccounts body flag to true — in that mode only pending transfers block deletion, and either all accounts are deleted or none are.

Path Params

enterpriseId string required

Your enterprise id.

at least 1 characters · matches ^[0-9a-f]{32}$
accountId string required

The account ID to delete.

Header Params

user-id string required

User id of the user making the request.

at least 1 characters

Body Params

object

Optional body for the delete account request. Contains the deleteAllSubAccounts flag, which controls whether sub-accounts are deleted together with the main account.

deleteAllSubAccounts boolean

Delete all sub-accounts together with the main account in a single atomic operation. When true, deletion is skipped if any account (main or sub-account) has pending transfers, and either every non-deleted sub-account and the main account are deleted, or none are. When false or omitted, deletion fails with 409 if the account still has active sub-accounts.

Responses

200

OK

Response Body

object

id string required
venueId string required

at least 1 characters
credentials array of objects required
credentials object
- id string required
- accessLevels array of string enums required
  
  readwriteread_write
- expirationDate string
  
  at least 1 characters
status string enum required

activeinactivedeletedpending_credentialsrestricted
name string required

at least 1 characters
description string required

at least 1 characters
whitelistingEnabled boolean required
parentAccount string
users array of objects
users object
- permissions array of string enums required
  
  link.account.adminlink.account.transferlink.account.view
- userId string required
  
  at least 1 characters
createdDate string date-time required
modifiedDate string date-time required

401

Unauthorized

Response Body

object

Standard structured error response payload for Link API v1 error responses. Contains an error name and human-readable error message.

errorName string required
error string required

403

Forbidden

Response Body

object

Standard structured error response payload for Link API v1 error responses. Contains an error name and human-readable error message.

errorName string required
error string required

404

Not Found

Response Body

object

Standard structured error response payload for Link API v1 error responses. Contains an error name and human-readable error message.

errorName string required
error string required

409

Conflict

Response Body

object

Standard structured error response payload for Link API v1 error responses. Contains an error name and human-readable error message.

errorName string required
error string required

500

Internal Server Error

Response Body

object

Standard structured error response payload for Link API v1 error responses. Contains an error name and human-readable error message.

errorName string required
error string required

Language

Credentials

Bearer

Request

curl -X DELETE \
     --url 'https://app.bitgo-test.com/api/link/v1/enterprises/enterpriseId/accounts/accountId' \
     --header 'accept: application/json' \
     --header 'Authorization: Bearer YOUR_ACCESS_TOKEN' \
     --header 'user-id: string' \
     --header 'content-type: application/json' \
     --data '{,"deleteAllSubAccounts":true}'

Request

const url = 'https://app.bitgo-test.com/api/link/v1/enterprises/enterpriseId/accounts/accountId';
const options = {
  method: 'DELETE',
  headers: {accept: 'application/json', 'Authorization': 'Bearer YOUR_ACCESS_TOKEN', 'user-id': 'string', 'content-type': 'application/json'},
  body: JSON.stringify({,"deleteAllSubAccounts":true})
};

fetch(url, options)
  .then(res => res.json())
  .then(json => console.log(json))
  .catch(err => console.error(err));

Request

require 'uri'
require 'net/http'

url = URI("https://app.bitgo-test.com/api/link/v1/enterprises/enterpriseId/accounts/accountId")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Delete.new(url)
request["accept"] = 'application/json'
request["Authorization"] = 'Bearer YOUR_ACCESS_TOKEN'
request["user-id"] = 'string'
request["content-type"] = 'application/json'
request.body = '{,"deleteAllSubAccounts":true}'

response = http.request(request)
puts response.read_body

Request

<?php
require_once('vendor/autoload.php');

$client = new \GuzzleHttp\Client();

$response = $client->request('DELETE', 'https://app.bitgo-test.com/api/link/v1/enterprises/enterpriseId/accounts/accountId', [
  'headers' => [
    'accept' => 'application/json',
    'Authorization' => 'Bearer YOUR_ACCESS_TOKEN',
    'user-id' => 'string',
    'content-type' => 'application/json',
  ],
  'body' => '{,"deleteAllSubAccounts":true}',
]);

echo $response->getBody();

Request

import requests

url = "https://app.bitgo-test.com/api/link/v1/enterprises/enterpriseId/accounts/accountId"

payload = {,"deleteAllSubAccounts":true}
headers = {
    "accept": "application/json",
    "Authorization": "Bearer YOUR_ACCESS_TOKEN",
    "user-id": "string",
    "content-type": "application/json"
}

response = requests.delete(url, json=payload, headers=headers)

print(response.text)

Response

{
  "id": "string",
  "venueId": "string",
  "credentials": [
    {
      "id": "string",
      "accessLevels": [
        "read"
      ],
      "expirationDate": "string"
    }
  ],
  "status": "active",
  "name": "string",
  "description": "string",
  "whitelistingEnabled": true,
  "parentAccount": "string",
  "users": [
    {
      "permissions": [
        "link.account.admin"
      ],
      "userId": "string"
    }
  ],
  "createdDate": "string",
  "modifiedDate": "string"
}

{
  "errorName": "string",
  "error": "string"
}

{
  "errorName": "string",
  "error": "string"
}

{
  "errorName": "string",
  "error": "string"
}

{
  "errorName": "string",
  "error": "string"
}

{
  "errorName": "string",
  "error": "string"
}