Anonymize a contact (GDPR erasure, irreversible)

POST

/contacts/{id}/anonymize

const url = 'https://app.surveyrock.com/api/v1/contacts/example/anonymize';
const options = {
  method: 'POST',
  headers: {'Idempotency-Key': 'example', Authorization: 'Bearer <token>'}
};

try {
  const response = await fetch(url, options);
  const data = await response.json();
  console.log(data);
} catch (error) {
  console.error(error);
}

curl --request POST \
  --url https://app.surveyrock.com/api/v1/contacts/example/anonymize \
  --header 'Authorization: Bearer <token>' \
  --header 'Idempotency-Key: example'

Authorizations

bearerAuth
contacts:suppress

Parameters

Path Parameters

required

string

Header Parameters

Idempotency-Key

required

string

>= 1 characters <= 128 characters

1 to 128 characters, chosen by the caller. A retry with the same key and body replays the first response instead of applying the write twice; the same key with a different body is a 409

Responses

200

Contact anonymized

404

Contact not found

409

Confirmation required (high-stakes action)