Create customer purge

POST/workspaces/{organizationId}/customers/purge

Path parameters

organizationIdstringrequired

Request body

application/json

sourcedBystring

sourceSessionstring

dryRunboolean

Responses

200

Purged agent-sourced customers

matchednumberrequired

deletednumberrequired

idsstring[]required

Try it

Server

Custom base URLOverrides the selected server when set.

Parameters

organizationIdpath*

Bodyapplication/json

sourcedBystringsourceSessionstringdryRunboolean

Request

curl -X POST '/workspaces/string/customers/purge' \
  -H 'Accept: application/json' \
  -H 'Content-Type: application/json' \
  -d '{
  "sourcedBy": "string",
  "sourceSession": "string",
  "dryRun": true
}'

const response = await fetch("/workspaces/string/customers/purge", {
  method: "POST",
  headers: {
    "Accept": "application/json",
    "Content-Type": "application/json"
  },
  body: "{\n  \"sourcedBy\": \"string\",\n  \"sourceSession\": \"string\",\n  \"dryRun\": true\n}"
});

import requests

response = requests.post(
    "/workspaces/string/customers/purge",
    headers={
        "Accept": "application/json",
        "Content-Type": "application/json"
    },
    data="{\n  \"sourcedBy\": \"string\",\n  \"sourceSession\": \"string\",\n  \"dryRun\": true\n}",
)

Response

{
  "matched": 0,
  "deleted": 0,
  "ids": [
    "string"
  ]
}