Subscriptions

Update a subscriber (status, contact fields, pause/resubscribe)

Legacy flat URL shape. Setting status to "paused" requires pausedUntil (a future date). Accepts an API key or a whitelisted Origin header.

Double opt-in: when it is on for the list and the request uses an API key, setting status to "active" on an unverified or unsubscribed subscriber does not activate them - they keep their status, get the verification email, and the response includes verificationEmailSent: true. They become active only by clicking its link. A paused subscriber is reactivated directly. With a SubscriptionToken the change applies directly.

patch/v1/subscriber-lists/{id}/{email}

Request

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

Path parameters

idstring required

The subscriber list _id.

emailstring required

Request body

emailstring
status'active' | 'paused' | 'unsubscribed'
pausedUntilstring date-time

Response

OK

Changes

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