Create subscriber

Create new subscriber with specified details

Authorizations

Authorization

string

header

required

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

Body

application/json

Details of customer being created

Customer details

customerReferenceId

string

required

Unique customer reference ID

Example:

"12345"

locale

string

required

Customer locale (language_country)

Example:

"en_US"

email

string

required

Customer's email address

Example:

"[e-mail]"

firstName

string

required

Customer's first name

Example:

"Pat"

lastName

string

required

Customer's last name

Example:

"Kake"

communicationPreference

object

required

Customer's communications preferences

Show child attributes

communicationPreference.email

boolean

true: Customer agrees to be contacted via email<br />false: Customer does not want to be contacted via email

Example:

true

communicationPreference.sms

boolean

true: Customer agrees to be contacted via text message<br />false: Customer does not want to be contacted via text message

Example:

true

contactnumber

string

Customer's contact number

Example:

"[phone]"

middleName

string

Customer's middle name or initial

Example:

"E"

segment

string[]

Customer's segments

Customer's segment (employee, management, pro user, etc.)

employeeId

string

Customer employee ID

Example:

"345"

Response

200

application/json

Request processed successfully

Customer details after creation

id

string

Customer ID

Example:

"62cffd65e8d7eb868c6a29d6"

customerReferenceId

string

Customer reference ID

Example:

"12345"

locale

string

Customer locale (language_country)

Example:

"en_US"

email

string

Customer's email address

Example:

"[e-mail]"

contactNumber

string

Customer's contact number

Example:

"[phone]"

firstName

string

Customer's first name

Example:

"Pat"

middleName

string

Customer's middle name or initial

Example:

"E"

lastName

string

Customer's last name

Example:

"Kake"

segment

string[]

Customer's segments

Customer's segment (employee, management, pro user, etc.)

employeeId

string

Customer employee ID

Example:

"345"

communicationPreference

object

Customer's communications preferences

Show child attributes

communicationPreference.email

boolean

true: Customer agrees to be contacted via email<br />false: Customer does not want to be contacted via email

Example:

true

communicationPreference.sms

boolean

true: Customer agrees to be contacted via text message<br />false: Customer does not want to be contacted via text message

Example:

true

status

enum<string>

Customer status

Available options:

ACTIVE,

INACTIVE

Example:

"ACTIVE"

createdAt

string

Time customer was created

Example:

"2021-10-12T21:35:05.756Z"

updatedAt

string

Most recent time customer was updated

Example:

"2021-10-14T05:40:55.997Z"