Unsubscribe through an edition’s link

POST

/v1/newsletters/unsubscribe

const url = 'https://your-tenant-host/v1/newsletters/unsubscribe';
const options = {method: 'POST'};

try {
  const response = await fetch(url, options);
  const data = await response.json();
  console.log(data);
} catch (error) {
  console.error(error);
}

curl --request POST \
  --url https://your-tenant-host/v1/newsletters/unsubscribe

Enqueues the unsubscribe and answers 200. The signature is checked afterwards, against the Braze profile u names, so a 200 does not mean the link was valid. As the RFC 8058 one-click target (List-Unsubscribe=One-Click): no body back, and the link’s own list. From the page’s form (page, list repeated): the ticked lists on that site, and a confirmation page. Safe to retry.

Parameters

Query Parameters

The recipient’s Braze profile id.

string

<= 128 characters

The recipient’s Braze profile id.

The list the link unsubscribes from.

string

<= 128 characters

The list the link unsubscribes from.

The edition that carried it. Unsigned provenance.

string

<= 128 characters

The edition that carried it. Unsigned provenance.

sig

HMAC-SHA256 of <email lowercased>|<external_id>|<l>, hex, under the tenant’s link key.

string

<= 256 characters

HMAC-SHA256 of <email lowercased>|<external_id>|<l>, hex, under the tenant’s link key.

Responses

200

Enqueued.

text/html

string

400

Invalid request.

application/json

object

error

required

object

code

required

string

message

required

string

details

Example

{
  "error": {
    "code": "unauthorized",
    "message": "Invalid or missing API key."
  }
}

422

Request validation failed.

application/json

object

error

required

object

code

required

string

message

required

string

details

Example

{
  "error": {
    "code": "unauthorized",
    "message": "Invalid or missing API key."
  }
}

500

Unexpected error.

application/json

object

error

required

object

code

required

string

message

required

string

details

Example

{
  "error": {
    "code": "unauthorized",
    "message": "Invalid or missing API key."
  }
}

503

With Retry-After, briefly unavailable; without it, not configured.

application/json

object

error

required

object

code

required

string

message

required

string

details

Example

{
  "error": {
    "code": "unauthorized",
    "message": "Invalid or missing API key."
  }
}