Subscriber Lists

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

Project-scoped equivalent of PATCH /v1/subscriber-lists/{id}/{email} (which is a legacy flat URL shape kept for hosted signup forms). Setting status to "paused" requires pausedUntil (a future date). Accepts a SubscriptionToken in place of an api key - see that security scheme's description for how a custom subscription-preferences page uses this to let a subscriber pause or unsubscribe.

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/projectId/{projectId}/subscriber-lists/{id}/subscribers/{email}

Request

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

Path parameters

projectIdstring required

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

idstring required

The subscriber list _id.

emailstring required

Request body

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

Response

OK

statusinteger

Example response

{
  "status": 200
}

Changes

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