Bulk delete contacts

POST

/contacts/bulk-delete

const url = 'https://app.surveyrock.com/api/v1/contacts/bulk-delete';
const options = {
  method: 'POST',
  headers: {
    'Idempotency-Key': 'example',
    Authorization: 'Bearer <token>',
    'Content-Type': 'application/json'
  },
  body: '{"ids":["example"]}'
};

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/bulk-delete \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --header 'Idempotency-Key: example' \
  --data '{ "ids": [ "example" ] }'

Authorizations

bearerAuth
contacts:write

Parameters

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

Request Body^required

application/json

object

ids

required

Array<string>

Example^generated

{
  "ids": [
    "example"
  ]
}

Responses

200

Bulk delete result with counts