Subscriber Lists

List every subscriber list an email can manage, with its current status on each

The endpoint behind a subscriber-facing subscription-preferences page: every public list in the project, plus - if authenticating with a SubscriptionToken minted for one - the single private list it names, each carrying this email's current status (active/paused/unsubscribed) where a subscription exists. Building a custom preferences page for this project? See the SubscriptionToken security scheme below for the full flow: take the token query parameter off the unsubscribe/pause-subscription link, call this endpoint with it to render the page, then PATCH/POST the individual subscriber-lists endpoints (same token) as the subscriber makes changes.

get/v1/projectId/{projectId}/subscriber-lists/public/{email}

Request

  • Base URL: https://api.bluefox.email
  • URL: https://api.bluefox.email/v1/projectId/{projectId}/subscriber-lists/public/{email}
  • Auth: one of:
    • HTTP bearer
    • HTTP bearer

Path parameters

projectIdstring required

The project _id, found in the app under Project Settings.

emailstring required

Response

OK

statusinteger

Example response

{
  "status": 200
}

Changes

No recorded changes to this operation across all 1 revision of this API.