Link Accounts

Update a Link account

Changed on

Updates a Link account's details. Supports updating name, description, status, credentials, and whitelisting flag.

patch/api/link/v1/enterprises/{enterpriseId}/accounts/{accountId}

Request

  • Base URL
    https://developers.bitgo.com
  • URL
    https://developers.bitgo.com/api/link/v1/enterprises/{enterpriseId}/accounts/{accountId}
  • Auth
    none declared. Required headers: user-id

Path parameters

enterpriseIdstring required
Example:59cd72485007a239fb00282ed480da1f

Your enterprise id.

accountIdstring required
Example:aba3a693-4f28-4523-8e53-85a3df22a608

The account ID to update.

Headers

user-idstring required

User id of the user making the request.

Request body

namestring

Updated account name. Must be unique within the enterprise, max 60 characters.

descriptionstring

Updated account description. Max 256 characters.

status'active' | 'inactive'

Updated account status. Only active or inactive allowed.

whitelistingEnabledboolean

Updated whitelisting flag.

Example request

{
  "name": "My Coinbase Account v2",
  "description": "Updated description",
  "status": "inactive",
  "whitelistingEnabled": true
}

Response

OK

idstring required
venueIdstring required
status'active' | 'inactive' | 'deleted' | 'pending_credentials' | 'restricted' required
namestring required
descriptionstring required
whitelistingEnabledboolean required
parentAccountstring
createdDatestring date-time required
modifiedDatestring date-time required

Changes