POST https://api.usecommune.comsubscriber.unsubscribed Production. There is no separate sandbox host.

Subscriber unsubscribed

A subscriber stopped being mailable. data.reason says why.

self_service: the reader opted out themselves, either through the unsubscribe link in an email or the RFC 8058 one-click header, or from inside the Commune app.

bounced and complained: forced by delivery telemetry rather than chosen by the reader, so they arrive alongside delivery.bounced or delivery.complained.

removed: the newsletter took them off its list, which is the only reason the reader did not cause. actor names the credential that did it. It covers two different writes and the difference is whether the record survived: Update a subscriber (PATCH /subscribers/{subscriber}) sets the status and keeps the row, and Erase a subscriber (DELETE /subscribers/{subscriber}) erases it along with its tags and its delivery history. After a deletion GET /subscribers/{subscriber} answers 404, which is how a consumer tells them apart.

On the other three reasons the subscriber record survives with its status changed, so bounce and complaint history is kept and a later resubscribe reuses it.

Delivered as a single HTTPS POST to the consumer's registered endpoint, with the message as the JSON request body. Respond 2xx to acknowledge. Anything else, or a timeout, is retried with backoff, so acknowledge fast and do the work afterwards.

Request Headers

  • string Required
  • string(uuid) Required
  • string Required
  • string Required
  • string(date-time) Required
  • integer

Body

A subscriber stopped being mailable.

  • string(uuid) Required
  • string Required
  • string Required
  • string(date-time) Required
  • string(uuid) | null Required
  • string | null Required
POST subscriber.unsubscribed
Loading...

Share your request

Use this link to easily share a pre-filled request of this operation. Everything you filled will be shared apart from the authentication fields.

Request URL

https://api-reference.usecommune.dev/explorer/operation/operation-onsubscriberunsubscribed

Send a delete request

It looks like you’re about to send a DELETE request to this API. This type of request carries a risk of permanent and irreversible data loss.

Are you sure you want to continue?
Response
Waiting for a request to be sent.