Skip to main content
POST
Create Subscriber

Authorizations

Authorization
string
header
default:your-api-key
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Body

application/json

Use from a backend server only. optInAttestation must be true to confirm the subscriber explicitly opted in.

email
string<email>
required
optInAttestation
enum<boolean>
required
Available options:
true
tags
string[]
customFields
object
sourceType
enum<string>
Available options:
manual,
subscribe_page,
social_post,
embed,
import,
api,
referral
source
string
Maximum string length: 160
sourceIssueId
string
sourcePostId
string
sourcePlatform
enum<string>
Available options:
x,
linkedin

Response

Subscriber created or updated.

ok
enum<boolean>
required
Available options:
true
data
object
required