---
title: "Subscribe to email lists (authenticated)"
method: POST
path: "/api/lists.subscribe"
---

# Subscribe to email lists (authenticated)

`POST /api/lists.subscribe`

Subscribe a contact to one or more email lists. This is an authenticated endpoint that requires a bearer token.

Unlike the public `/subscribe` endpoint, this endpoint can subscribe contacts to **any list** (public or private) as long as the authenticated user has write permission on lists.

**Note:** Double opt-in is bypassed for authenticated requests. Contacts are immediately set to `active` status regardless of the list's double opt-in setting. This allows administrators to manually add contacts without requiring email confirmation.

## Request body

- SubscribeToListsRequest
  - `workspace_id` string, required — The ID of the workspace
  - `contact` SubscriptionContact, required
    - `email` string, email, required — Email address of the contact
    - `email_hmac` string — HMAC of the email for authenticated subscription (optional)
    - `external_id` string, nullable — Optional identifier for the contact in your own system. Not unique — contacts are identified by email address.
    - `timezone` string, nullable — Timezone of the contact
    - `language` string, nullable — Preferred language of the contact
    - `first_name` string, nullable — First name of the contact
    - `last_name` string, nullable — Last name of the contact
    - `full_name` string, nullable — Full name of the contact (for systems that don't have separate first/last names)
    - `phone` string, nullable — Phone number of the contact
    - `address_line_1` string, nullable — First line of address
    - `address_line_2` string, nullable — Second line of address
    - `country` string, nullable — Country of the contact
    - `postcode` string, nullable — Postal code
    - `state` string, nullable — State or province
    - `job_title` string, nullable — Job title of the contact
    - `custom_string_1` string, nullable — Custom string field 1
    - `custom_string_2` string, nullable — Custom string field 2
    - `custom_string_3` string, nullable — Custom string field 3
    - `custom_string_4` string, nullable — Custom string field 4
    - `custom_string_5` string, nullable — Custom string field 5
    - `custom_number_1` number, float, nullable — Custom number field 1
    - `custom_number_2` number, float, nullable — Custom number field 2
    - `custom_number_3` number, float, nullable — Custom number field 3
    - `custom_number_4` number, float, nullable — Custom number field 4
    - `custom_number_5` number, float, nullable — Custom number field 5
    - `custom_datetime_1` string, date-time, nullable — Custom datetime field 1
    - `custom_datetime_2` string, date-time, nullable — Custom datetime field 2
    - `custom_datetime_3` string, date-time, nullable — Custom datetime field 3
    - `custom_datetime_4` string, date-time, nullable — Custom datetime field 4
    - `custom_datetime_5` string, date-time, nullable — Custom datetime field 5
    - `custom_json_1` object, nullable — Custom JSON field 1
    - `custom_json_2` object, nullable — Custom JSON field 2
    - `custom_json_3` object, nullable — Custom JSON field 3
    - `custom_json_4` object, nullable — Custom JSON field 4
    - `custom_json_5` object, nullable — Custom JSON field 5
  - `list_ids` string[], required — Array of list IDs to subscribe the contact to

## Response `200`

Subscription successful

- object
  - `success` boolean — Whether the subscription was successful

## Other responses

- `400` — Bad request - validation failed
- `401` — Unauthorized - invalid or missing authentication token
- `500` — Internal server error

## Changes

- **2025-12-01** `bca4a43d9d46` — 1 info
  - endpoint added

[Change history](https://skmtc.dev/pierre-b/apis/notifuse-api/changes/api/lists.subscribe/post.md)

---

[API](https://skmtc.dev/pierre-b/apis/notifuse-api.md) · [All operations](https://skmtc.dev/pierre-b/apis/notifuse-api/llms.txt) · [OpenAPI document](https://skmtc-service-production.skmtc.workers.dev/v1/apis/pierre-b/notifuse-api/revisions/d26605f2fc47/schema)