billing

Redeem a one-click unsubscribe link from an email

Keyless, and idempotent. This is the endpoint named by the List-Unsubscribe / List-Unsubscribe-Post headers on every non-legal email (RFC 8058): the mail client POSTs it with no session, so the HMAC over user, category and expiry is the whole authentication. Switches that one category off and leaves the other as it stands. A tampered, expired or unknown link is one 403 with one sentence — never a hint about whether the user exists. Legal notices are not switchable and no link is ever minted for one.

post/v1/email/unsubscribe

Request

  • Base URL: https://api.hyperresearch.ai
  • URL: https://api.hyperresearch.ai/v1/email/unsubscribe
  • Auth: none required

Query parameters

ustring required

The user the link was minted for.

cstring required

The category to switch off: runs, product or onboarding.

expinteger nullable

Unix seconds the link stops working.

sigstring required

HMAC over the three above.

Response

The category is off

runsboolean required

Emails about your own runs: the report is ready, the run stopped and was refunded, the run is waiting on a question. On by default.

productboolean required

Account housekeeping: a card was added, a payment was declined. On by default.

onboardingboolean required

Tips for a new account: a welcome when you sign up and, if no run has started, one reminder a day later. Separate from product, so turning these off never stops a payment-failed email. On by default.

legal_notices_alwaysboolean required

Always true. Notice of a material change to the Terms, of the service being discontinued, or of a security incident is sent whatever these switches say — it is an obligation under the agreement, not a subscription. There is no field to turn it off and no column behind one.

Changes

No recorded changes to this operation across all 1 revision of this API.