Skip to content

Request a confirmed page-specific email subscription ​

Only enabled pages on active public sites are available. Subscription endpoints are rate limited to ten requests per ten minutes per IP. Subscribe returns pending/confirmed state and a message, never a token or saved preferences. Existing email requests never overwrite preferences. Manage sends an email link and does not delete or disclose tokens; requests for a subscriber are atomically limited to one every ten minutes. Pending confirmation resends use the same cooldown. Confirmed signed links stay stable across requests, are scoped to page and subscription ID, and cease working after deletion. GET links only render the verification/preferences page; confirmation, saving and unsubscribe require explicit POST actions. Browser email storage only prefills this page; verified link capabilities are retained separately for this page in browser storage. Confirm and unsubscribe accept an empty body. Save requires confirmed email and component preferences. Keys, ping URLs, and raw source descriptions are never public.

Request preparation ​

Send a POST request to /s/{slug}/status/subscribe 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:

  • slug (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 ​

This operation does not declare an OpenAPI security requirement. Check the description and parameter definitions for any signed URL, customer identity, webhook, or browser-session conditions before using it outside a test environment.

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 Request a confirmed page-specific email subscription are:

  • 200: HTML page or subscription acknowledgement
  • 400: Invalid preferences or expired confirmation link
  • 404: Disabled, unavailable, or incorrect page or token
  • 429: Too many subscription requests

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.

Request a confirmed page-specific email subscription​

POST
/s/{slug}/status/subscribe

Only enabled pages on active public sites are available. Subscription endpoints are rate limited to ten requests per ten minutes per IP. Subscribe returns pending/confirmed state and a message, never a token or saved preferences. Existing email requests never overwrite preferences. Manage sends an email link and does not delete or disclose tokens; requests for a subscriber are atomically limited to one every ten minutes. Pending confirmation resends use the same cooldown. Confirmed signed links stay stable across requests, are scoped to page and subscription ID, and cease working after deletion. GET links only render the verification/preferences page; confirmation, saving and unsubscribe require explicit POST actions. Browser email storage only prefills this page; verified link capabilities are retained separately for this page in browser storage. Confirm and unsubscribe accept an empty body. Save requires confirmed email and component preferences. Keys, ping URLs, and raw source descriptions are never public.

Parameters​

Path Parameters

slug*
Type
string
Required

Request Body​

application/json
JSON
"string"

Responses​

HTML page or subscription acknowledgement

Playground​

Variables
Key
Value
Body

Samples​

Powered by VitePress OpenAPI