Delete an account

Deletes an account.

DELETE /accounts/{account_id}

cURL

cURL

curl -X DELETE "$EXSITED_BASE_URL/api/v4/accounts/ACC0001" \
  -H "Authorization: Bearer $ACCESS_TOKEN"

409

{
  "object": "<string>",
  "request_id": "<string>",
  "status": 123,
  "code": "<string>",
  "message": "<string>",
  "doc_url": "<string>",
  "errors": [
    {
      "field": "<string>",
      "code": "<string>",
      "message": "<string>",
      "doc_url": "<string>"
    }
  ]
}

Deletes the account and returns 204 with no content. An account with orders, invoices or payments against it is locked and returns 409; retrying does not help.

The SDK samples get their client from credentials your app registers once when it starts, as shown in Authentication. To try the call here, click Try it, set host to your Exsited API host name and paste an access token from Get an access token.

Authorizations

Authorization · string · header · required

An access token from POST /api/v4/oauth2/token. The SDKs get and renew it for you.

Path Parameters

account_id · string · required

The account's id, such as ACC0001. Not its uuid.

Response

204

The account is deleted. Retrieving it then returns 404.