Skip to main content
POST
Subscribe a person to an email list.

Authorizations

Authorization
string
header
required

Enter your access token (OAuth / JWT).

Path Parameters

emailListUid
string | null
required

The email list's unique identifier

Body

application/json

The subscription to create, including the Person and EmailList references

Uid
string | null
Maximum string length: 10
_objectType
string | null
ActivityEventData
unknown
EmailList
object | null
Person
Person · object | null

Circular reference to Person (not expanded here).

EmailListSubscriberStatus
enum<integer>

1 - Subscribed, 2 - Unsubscribed, 3 - Cleaned, 4 - Confirmed

Available options:
1,
2,
3,
4
Required range: 1 <= x <= 4
SubscribedDate
string<date-time>
ConfirmedDate
string<date-time> | null
ConfirmationNotes
string | null
Maximum string length: 500
UnsubscribedDate
string<date-time> | null
CleanedDate
string<date-time> | null
WelcomeEmailDeliverDateTime
string<date-time> | null
WelcomeEmailOpenDateTime
string<date-time> | null
UnsubscribeReason
string | null
Maximum string length: 20
UnsubscribeReasonOther
string | null
RecaptchaToken
string | null
RecaptchaSiteKey
string | null
SendWelcomeEmail
boolean
Source
string | null

Response

Created
string<date-time>
required
read-only
Minimum string length: 1
Updated
string<date-time>
required
read-only
Minimum string length: 1
Uid
string | null
Maximum string length: 10
_objectType
string | null
ActivityEventData
unknown
EmailList
object | null
Person
Person · object | null

Circular reference to Person (not expanded here).

EmailListSubscriberStatus
enum<integer>

1 - Subscribed, 2 - Unsubscribed, 3 - Cleaned, 4 - Confirmed

Available options:
1,
2,
3,
4
Required range: 1 <= x <= 4
SubscribedDate
string<date-time>
ConfirmedDate
string<date-time> | null
ConfirmationNotes
string | null
Maximum string length: 500
UnsubscribedDate
string<date-time> | null
CleanedDate
string<date-time> | null
WelcomeEmailDeliverDateTime
string<date-time> | null
WelcomeEmailOpenDateTime
string<date-time> | null
UnsubscribeReason
string | null
Maximum string length: 20
UnsubscribeReasonOther
string | null
RecaptchaToken
string | null
RecaptchaSiteKey
string | null
SendWelcomeEmail
boolean
Source
string | null