Skip to main content
POST
Create a subscriber
When status is pending, the subscriber receives a confirmation email. When active, the subscriber becomes active directly and no confirmation email is sent.
A duplicate email within the same newsletter returns 422 with code email_already_subscribed.

Authorizations

Authorization
string
header
required

Your API key, sent as Authorization: Bearer sk_....

Body

application/json
email
string<email>
required

Subscriber email address.

Maximum string length: 254
Example:

"user@example.com"

name
string | null

Full name. Stored as first + last name, split on the first space.

Maximum string length: 255
Example:

"John Doe"

status
enum<string>

Optional. active makes the subscriber active directly; pending sends a confirmation email.

Available options:
active,
pending

Response

Subscriber created.

success
boolean
data
object