Skip to main content
POST
Archive an account

Authorizations

Authorization
string
header
required

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

Path Parameters

accountId
string
required

Identifier of the account.

Example:

"1000565227"

Body

application/json
idempotencyKey
string<uuid>

Universally unique identifier (UUID v4) idempotency key. This key is utilized to ensure exactly-once execution of mutating requests.

Example:

"ba943ff1-ca16-49b2-ba55-1057e70ca5c7"

Response

Successfully archived the account.

data
object

An account exposed by the Accounts API.