Skip to content

Add a normalized email and request confirmation ​

Owner/admin access required for every operation, including sensitive email listing. Account, site and page scoped. Lists return up to 25 items ordered by ID and a next cursor; send it as after to reach later subscribers. Items contain id, version and server-rendered row HTML showing email, Pending/Confirmed and confirmed_at, falling back to clearly labeled createdAt or requested_at. Add trims and lowercases email, uses the unique page/email index, sends the existing confirmation email and preserves existing pending/confirmed preferences. Adding requires an enabled public page and active public site so confirmation is reachable; otherwise returns 409 without creating a subscriber. Remove returns id and deleted; repeating it is safe. HTTP and realtime updates use the same stable row updater without reloading the editor.

Request preparation ​

Send a POST request to /sites/{siteId}/status/pages/{id}/subscribers on the appropriate server. Check the API overview for base URL guidance and the server information in the interactive reference. Replace path placeholders with identifiers from the intended account or site; a similarly named record in another workspace is not interchangeable.

The declared request parameters are:

  • siteId (path, required): Use the type and constraints shown in the parameter reference.
  • id (path, required): Use the type and constraints shown in the parameter reference.

This operation defines a required request body. Documented media types: application/json. Review required fields, nested objects, and allowed values in the request schema. Keep identifiers and field types intact when replacing example data with your own values.

Authentication and scope ​

The specification lists these security alternatives: AdminSession, BearerAuth, AccessToken. Read any operation-specific restrictions as well: browser-session, account-role, and signed-user requirements may impose additional conditions. See authentication before choosing a credential.

Keep credentials in the appropriate private configuration and remove secrets from shared logs. Confirm the target resource belongs to the intended workflow before issuing a request. Authentication alone should not be treated as confirmation that a supplied account, site, or customer identifier is correct.

Response handling ​

The documented responses for Add a normalized email and request confirmation are:

  • 200: Saved state or server-rendered HTML fragment. No credentials are returned.
  • 400: Invalid input
  • 403: Account admin or plan access required
  • 404: Site or status page unavailable in this account
  • 409: Slug, portal page, or hostname collision

Exercise this operation with controlled test data before enabling it in an automated workflow. Validate the request against the schema and inspect the response before updating local state. Do not assume that a successful response means background processing has finished; follow any documented status or follow-up operation when the action queues additional work.

If a connection fails after submission, investigate the current server state before repeating an action whose outcome is uncertain. When requesting support, retain the method, route, response status, and sanitized error message. The interactive reference below provides the detailed schemas and examples for this specific operation.

Add a normalized email and request confirmation​

POST
/sites/{siteId}/status/pages/{id}/subscribers

Owner/admin access required for every operation, including sensitive email listing. Account, site and page scoped. Lists return up to 25 items ordered by ID and a next cursor; send it as after to reach later subscribers. Items contain id, version and server-rendered row HTML showing email, Pending/Confirmed and confirmed_at, falling back to clearly labeled createdAt or requested_at. Add trims and lowercases email, uses the unique page/email index, sends the existing confirmation email and preserves existing pending/confirmed preferences. Adding requires an enabled public page and active public site so confirmation is reachable; otherwise returns 409 without creating a subscriber. Remove returns id and deleted; repeating it is safe. HTTP and realtime updates use the same stable row updater without reloading the editor.

Authorizations​

AdminSession

Authenticated backend-admin session cookie.

Type
API Key (cookie: connect.sid)
or
BearerAuth

JWT token from login

Type
HTTP (bearer)
or
AccessToken

Personal access token. Value: Token <your-token>

Type
API Key (header: Authorization)

Parameters​

Path Parameters

siteId*
Type
string
Required
Pattern
"^[a-fA-F0-9]{24}$"
id*
Type
string
Required

Request Body​

application/json
JSON
{
  
"email": "string"
}

Responses​

Saved state or server-rendered HTML fragment. No credentials are returned.

Playground​

Authorization
Variables
Key
Value
Body

Samples​

Powered by VitePress OpenAPI