API reference · v1
Emails
Public email recipient actions.
One-click unsubscribe
POST
/v1/emails/{emailId}/unsubscribePublic endpoint · no API key required
Public RFC 8058 one-click unsubscribe target. Unsubscribes the linked contact from a topic or the whole email channel, then redirects (302) to the hosted result page. No rate limit at all on this endpoint.
Path parameters
- Name
emailId- Type
- string
- Requirement
- Required
- Description
- The id of the sent email.
Request
curl --fail-with-body 'https://api.maxclicks.ai/v1/emails/email_BcwDvBUeSaSDILA5tHgpmU7I/unsubscribe' \
--include \
-X POSTStatus codes
- 302Redirect to the hosted unsubscribe result page.
- 400The request was malformed or failed validation. Also covers
malformed_json(body is not valid JSON) and, on list endpoints,offset_too_large. - 404The referenced resource was not found.
Working with these endpoints? See error handling, safe retries, client library guides, and the complete OpenAPI schema.