POST

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.

Header Params

request-id string

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

Body Params

object

List-Unsubscribe string required

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

Responses

200

Unsubscribed successfully

No response body

400

Invalid or expired token, or non-compliant RFC 8058 request body

No response body

429

Too many unsubscribe requests from this IP

No response body

500

Failed to update subscriptions

No response body

curl --request POST \ --url 'https://app.bitgo-test.com/api/notifications/v1/external/unsubscribe' \ --header 'accept: application/json' \ --header 'Authorization: Bearer YOUR_ACCESS_TOKEN' \ --header 'request-id: string' \ --header 'content-type: application/json' \ --data '{,"List-Unsubscribe":"One-Click"}'

const url = 'https://app.bitgo-test.com/api/notifications/v1/external/unsubscribe'; const options = { method: 'POST', headers: {accept: 'application/json', 'Authorization': 'Bearer YOUR_ACCESS_TOKEN', 'request-id': 'string', 'content-type': 'application/json'}, body: JSON.stringify({,"List-Unsubscribe":"One-Click"}) }; fetch(url, options) .then(res => res.json()) .then(json => console.log(json)) .catch(err => console.error(err));

require 'uri' require 'net/http' url = URI("https://app.bitgo-test.com/api/notifications/v1/external/unsubscribe") http = Net::HTTP.new(url.host, url.port) http.use_ssl = true request = Net::HTTP::Post.new(url) request["accept"] = 'application/json' request["Authorization"] = 'Bearer YOUR_ACCESS_TOKEN' request["request-id"] = 'string' request["content-type"] = 'application/json' request.body = '{,"List-Unsubscribe":"One-Click"}' response = http.request(request) puts response.read_body

<?php require_once('vendor/autoload.php'); $client = new \GuzzleHttp\Client(); $response = $client->request('POST', 'https://app.bitgo-test.com/api/notifications/v1/external/unsubscribe', [ 'headers' => [ 'accept' => 'application/json', 'Authorization' => 'Bearer YOUR_ACCESS_TOKEN', 'request-id' => 'string', 'content-type' => 'application/json', ], 'body' => '{,"List-Unsubscribe":"One-Click"}', ]); echo $response->getBody();

import requests url = "https://app.bitgo-test.com/api/notifications/v1/external/unsubscribe" payload = {,"List-Unsubscribe":"One-Click"} headers = { "accept": "application/json", "Authorization": "Bearer YOUR_ACCESS_TOKEN", "request-id": "string", "content-type": "application/json" } response = requests.post(url, json=payload, headers=headers) print(response.text)