Subscriptions

Subscribe a contact to a list

Legacy flat URL shape. Creates the contact if it doesn't exist yet. Auth: API key, or a whitelisted Origin (in which case a CAPTCHA is required unless the list disables it).

Double opt-in: when it is on for the list and the request uses an API key (or a whitelisted Origin), a new contact - or one who is unverified or unsubscribed on the list - is not activated. They get the verification email and stay as they are (new contacts become "unverified") until they click its link, and the response is { success: true, info } instead of the subscriber. Sending status "active" does not skip this. A paused subscriber is reactivated directly, without an email. With a SubscriptionToken the subscriber has already proven they own the address, so they are activated directly.

post/v1/subscriber-lists/{id}

Request

  • Base URL: https://api.bluefox.email
  • URL: https://api.bluefox.email/v1/subscriber-lists/{id}
  • Auth: HTTP bearer

Path parameters

idstring required

The subscriber list _id.

Request body

emailstring required
namestring
status'unverified' | 'active'
captchaTextstring
captchaProbestring

Response

Created

statusinteger

Example response

{
  "status": 200
}

Changes

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