Unsubscribe a contact (idempotent)

POST

/contacts/{id}/unsubscribe

const url = 'https://app.surveyrock.com/api/v1/contacts/example/unsubscribe';
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/unsubscribe \
  --header 'Authorization: Bearer <token>' \
  --header 'Idempotency-Key: example'

Unsubscribe a contact (idempotent). The response carries the resource’s next ETag, as the ETag header and as meta.etag.

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 unsubscribed (or already unsubscribed)

Headers

ETag

string

Example

"element:abc123:1790690123456789"

The resource’s current version, as a strong validator. Opaque: send it back unchanged as If-Match. Also returned as meta.etag in the body, for a client that only sees the body.

404

Contact not found