Skip to main content
POST
Create a new subscriber

Authorizations

Authorization
string
header
required

A session token from subscriber login, used by subscriber.dev's own apps. Requests about an environment also need its ID in the x-environment-id header. From your own code, use an API key.

Body

application/json
publicId
string

Bring your own identifier for this subscriber. Must be unique within the environment. If omitted, one is generated automatically.

Required string length: 1 - 255
email
string<email>
Pattern: ^(?:[A-Za-z0-9_'+\-]+\.)*[A-Za-z0-9_'+\-]*[A-Za-z0-9_+-]@(?:[A-Za-z0-9][A-Za-z0-9\-]*\.)+[A-Za-z]{2,}$
phone
string
externalId
string
firstName
string
lastName
string
name
string
attributes
object
preferences
object

Response

Subscriber created successfully

subscriber
object
required
preferences
object
required