Archive external account

Archives an external account for a business. This action will prevent the account from syncing new transactions and will remove the account from the Layer dashboard. Past synced transactions will remain.

POST /v1/businesses/{businessId}/external-accounts/{externalAccountId}/archive

Archive external account

cURL

curl --request POST \
  --url https://sandbox.layerfi.com/v1/businesses/{businessId}/external-accounts/{externalAccountId}/archive \
  --header 'Authorization: Bearer <token>'

200

{
  "type": "{}"
}

Authorizations

Authorization · string · header · required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Headers

Content-Type · string

Content-Type must be set to application/json.

Path Parameters

businessId · string · required

The UUID of the business to archive external account for.

externalAccountId · string · required

The UUID of the external account to archive.

Response

200

application/json

External account archived successfully.

type · string

Resource type. Value will be 'com.layerfi.controllers.EmptyResponse'.

Example:

"{}"