The unsubscribe page

GET

/v1/newsletters/unsubscribe

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

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

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

Renders EdgeKit’s own page in the publication’s locale and the site’s brand, offering every newsletter on the site, the link’s own ticked. Changes nothing and verifies nothing: a prefetching mail scanner must not unsubscribe anybody. On the tenant host only.

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

The page.

text/html

string

404

The link names no deployed newsletter.

text/html

string

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."
  }
}