Unsubscribe a contact (idempotent)

POST

/contacts/{id}/unsubscribe

const url = 'https://app.surveyrock.com/api/v1/contacts/example/unsubscribe';
const options = {method: 'POST', headers: {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/unsubscribe \
  --header 'Authorization: Bearer <token>'

Authorizations

bearerAuth
contacts:suppress

Parameters

Path Parameters

required

string

Responses

200

Contact unsubscribed (or already unsubscribed)

404

Contact not found