SCscanopy
internal

One-click unsubscribe

Changed on

Turns off one pausable email category for the user the token belongs to. Mail clients POST here from the List-Unsubscribe header. Answers 200 whether or not the token matched, so the endpoint does not reveal which tokens exist. The request body is ignored.

post/api/email/unsubscribe/{token}/{category}

Request

  • Base URL
    https://app.scanopy.net
  • URL
    https://app.scanopy.net/api/email/unsubscribe/{token}/{category}
  • Auth
    none declared

Path parameters

tokenstring required

The recipient's unsubscribe token

categorystring required

Pausable email category, e.g. discovery_digest

Response

Request accepted

dataTupleUnit

No payload. Present only so the envelope keeps its shape.

errorstring nullable

Not sent on a successful response. Failure messages arrive in an ApiErrorResponse.

successboolean required

Always true on a successful response.

Example response

{
  "meta": {
    "api_version": 1,
    "server_version": "0.19.4"
  }
}

Changes