User Management Notification

Perform one-click email unsubscribe (RFC 8058)

Processes an RFC 8058 one-click unsubscribe request and unsubscribes the user from the email notification category encoded in the token.

post/api/notifications/v1/external/unsubscribe

Request

  • Base URL
    https://developers.bitgo.com
  • URL
    https://developers.bitgo.com/api/notifications/v1/external/unsubscribe
  • Auth
    none declared

Headers

request-idstring

Optional client-supplied request ID used for log correlation and tracing

Request body application/x-www-form-urlencoded

List-Unsubscribestring required

RFC 8058 one-click unsubscribe form value. Must be 'One-Click'.

Example request

{
  "List-Unsubscribe": "One-Click"
}

Response

Unsubscribed successfully

Changes

No operation changes recorded.