Add a new subscriber

import { ParagraphAPI } from "@paragraph-com/sdk"

const api = new ParagraphAPI({ apiKey: "your-api-key" })
await api.subscribers.create({ email: "reader@example.com" })

{
  "success": true
}

{
  "success": false,
  "msg": "<string>"
}

{
  "success": false,
  "msg": "<string>"
}

{
  "success": false,
  "msg": "<string>"
}

{
  "success": false,
  "msg": "<string>"
}

POST

subscribers

import { ParagraphAPI } from "@paragraph-com/sdk"

const api = new ParagraphAPI({ apiKey: "your-api-key" })
await api.subscribers.create({ email: "reader@example.com" })

{
  "success": true
}

{
  "success": false,
  "msg": "<string>"
}

{
  "success": false,
  "msg": "<string>"
}

{
  "success": false,
  "msg": "<string>"
}

{
  "success": false,
  "msg": "<string>"
}

Authorizations

Authorization

string

header

required

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

Body

application/json

Body

string<email>

Email address of the subscriber

wallet

string

Wallet address of the subscriber (0x format)

Pattern: ^0x[a-fA-F0-9]{40}$

createdAt

number

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

Response

Subscriber added successfully

success

enum<boolean>

required

Whether the subscriber was added

Available options:

true

List subscribers Remove a subscriber

⌘I

publications

posts

me

users

coins

subscribers

discover

analytics

emails

auth

Add a new subscriber

Authorizations

Body

Response