Delete an account using your providerAccountId.

Use this endpoint when you identify accounts with your own IDs. To delete an account using the Arcadia-generated account identifier, use Delete Account with accountId.

Deleting an account does not remove the account record from the API. The account remains available for historical reference, but its status changes to DELETED.

Resource URI

DELETE /rest/v1/accounts/pid/{providerAccountId}

Path parameters

For the full account data model, account workflow, and detailed examples, see Accounts API.

Example

DELETE /rest/v1/accounts/pid/api-eg-01

A successful response returns a standard response payload indicating that the account status changed to DELETED.

{
  "status": "success",
  "count": 1,
  "type": "Account",
  "results": [
    {
      "providerAccountId": "api-eg-01",
      "status": "DELETED"
    }
  ]
}