ParagraphDocs
Open the app
GuidesDevelopers

Add a new subscriber

POST
/v1/subscribers

Add a new subscriber to your publication. The publication is identified by the API key provided in the Authorization header.

Requirements:

  • At least one of email or wallet must be provided
  • If both are provided, the subscriber will be associated with both credentials

Behavior:

  • If the subscriber already exists (by email or wallet), they will not be duplicated

Authorization

apiKey
headerAuthorizationBearer <token>

API key for authenticating protected endpoints. Pass as Bearer token in Authorization header.

Request Body

Body

application/json
  1. body
email?string

Email address of the subscriber

Formatemail
wallet?string

Wallet address of the subscriber (0x format)

Match^0x[a-fA-F0-9]{40}$
createdAt?number

Timestamp (in milliseconds) when the subscription was created. Defaults to current time.

Response Body

Subscriber added successfully

application/json
  1. response
success*true

Whether the subscriber was added

Value intrue
curl -X POST "https://example.com/v1/subscribers" \  -H "Content-Type: application/json" \  -d '{}'
{  "success": true}

List subscribers GET

Retrieve a paginated list of subscribers for your publication. The publication is identified by the API key provided in the Authorization header. **Response:** - Returns subscriber email and/or wallet address - Only active subscribers are returned - Results are ordered by subscription date (newest first)

Remove a subscriber DELETE

Remove a subscriber from your publication. The publication is identified by the API key provided in the Authorization header. Identify the subscriber by email, wallet, or both. **Requirements:** - At least one of `email` or `wallet` must be provided - If both are provided, they must resolve to the same subscriber **Behavior:** - The subscription is hard-deleted, mirroring the dashboard's "remove subscriber" action