---
title: "Update a subscriber (status, contact fields, pause/resubscribe)"
method: PATCH
path: "/v1/projectId/{projectId}/subscriber-lists/{id}/subscribers/{email}"
tags: ["Subscriber Lists"]
---

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

`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

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.

## Path parameters

- `projectId` string, required
- `id` string, required
- `email` string, required

## Request body

- object
  - `email` string
  - `status` 'active' | 'paused' | 'unsubscribed'
  - `pausedUntil` string, date-time

## Response `200`

OK

- object
  - `status` integer
  - `result` object
    - `email` string
    - `status` 'unverified' | 'active' | 'unsubscribed' | 'paused'
    - `customFields` object: Custom contact field values, keyed by field name.

## Other responses

- `400`: Invalid request body or query - every violation found (missing/invalid/unexpected fields) is reported in one response, semicolon-separated, not just the first one hit.
- `403`: Missing or invalid API key
- `404`: Subscriber not found
- `405`: The operation is blocked by a business rule (e.g. the resource is still in use)

---

[API](https://skmtc.dev/bluefox/apis/bluefox-email-public-api.md) · [All operations](https://skmtc.dev/bluefox/apis/bluefox-email-public-api/llms.txt) · [OpenAPI document](https://skmtc.dev/bluefox/apis/bluefox-email-public-api/revisions/fa1a0a835c7f?raw)