---
title: "Add a subscriber: confirmed true only with their consent; otherwise they get the confirmation email"
method: POST
path: "/business/lists/{listId}/subscribers"
tags: ["Business"]
---

# Add a subscriber: confirmed true only with their consent; otherwise they get the confirmation email

`POST /business/lists/{listId}/subscribers`

## Request

- Base URL: `https://hostingsurge.com/api/v1`
- URL: `https://hostingsurge.com/api/v1/business/lists/{listId}/subscribers`
- Auth: one of:
  - HTTP bearer
  - API key in cookie `__Host-hs_session`

## Path parameters

- `listId` string, uuid, required

## Request body

- object
  - `email` string, email, required
  - `name` string
  - `confirmed` boolean

## Response `201`

Added

- object
  - `id` string, uuid, required
  - `listId` string, uuid, required
  - `email` string, required
  - `name` string, nullable, required
  - `status` 'pending' | 'subscribed' | 'unsubscribed', required
  - `source` 'form' | 'dashboard' | 'api', required
  - `createdAt` string, required: ISO-8601 timestamp
  - `confirmedAt` string, nullable, required: ISO-8601 timestamp
  - `unsubscribedAt` string, nullable, required: ISO-8601 timestamp

## Other responses

- `400`: Invalid request (code invalid_request)
- `401`: Missing or invalid session/token (code unauthorized)
- `402`: A module limit was reached (code limit_reached)
- `403`: Authenticated but not permitted (code forbidden)
- `404`: Not found or not visible to the caller (code not_found)
- `409`: Not possible in the current state (code conflict)
- `429`: Too many requests (code rate_limited)
- `501`: Not available on this server (code not_configured)
- `503`: Stripe or the mail service did not answer (code provider_unavailable)

---

[API](https://skmtc.dev/hostingsurge/apis/hostingsurge-platform-api.md) · [All operations](https://skmtc.dev/hostingsurge/apis/hostingsurge-platform-api/llms.txt) · [OpenAPI document](https://skmtc.dev/hostingsurge/apis/hostingsurge-platform-api/revisions/4d08337cdff1?raw)
