Purge an account

POST

accounts

{account_id}

purge

cURL

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

import com.exsited.Dto;
import com.exsited.client.ApiResponse;
import com.exsited.client.ClientRegistry;
import com.exsited.client.ExsitedClient;

ExsitedClient client = ClientRegistry.buildClient();

ApiResponse<Dto> response = client.accounts().purgeAccount("ACC0001");
System.out.println(response.getMap());

import (
	"context"
	"fmt"
	"log"

	exsited "github.com/exsited/exsited-sdk-go/v4"
)

client, err := exsited.BuildClient(nil)
if err != nil {
	log.Fatal(err)
}
defer client.Close()

response, err := client.Accounts().PurgeAccount(context.Background(), "ACC0001", nil)
if err != nil {
	log.Fatal(err)
}
fmt.Println(response.Map)

Removes the account and its records for good. There is no undo. Send no body; a successful purge returns 204 with no content.

A purge cannot be undone.

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 and its records are removed.

Guides

API reference

Authorizations

Path Parameters

Response