Subscribe a person to an email list.

To subscribe a new person, pass a Person object with an Email address. To subscribe an existing person, pass a Person object with a Uid. The SendWelcomeEmail property determines if the person is sent a welcome email and defaults to false.

post/api/v1/email/lists/{emailListUid}/subscriptions

Request

Base URL: https://go.outseta.com
URL: https://go.outseta.com/api/v1/email/lists/{emailListUid}/subscriptions
Auth: one of:
- HTTP bearer
- API key in header Authorization

Path parameters

emailListUidstring nullable required

The email list's unique identifier

Request body

Uidstring nullable

_objectTypestring nullable

Createdstring date-time required

Updatedstring date-time required

ActivityEventDataunknown

EmailListSubscriberStatus1 | 2 | 3 | 4

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

SubscribedDatestring date-time

ConfirmedDatestring date-time nullable

ConfirmationNotesstring nullable

UnsubscribedDatestring date-time nullable

CleanedDatestring date-time nullable

WelcomeEmailDeliverDateTimestring date-time nullable

WelcomeEmailOpenDateTimestring date-time nullable

UnsubscribeReasonstring nullable

UnsubscribeReasonOtherstring nullable

RecaptchaTokenstring nullable

RecaptchaSiteKeystring nullable

SendWelcomeEmailboolean

Sourcestring nullable

Example request

{
  "Uid": "string",
  "_objectType": "string",
  "Created": "string",
  "Updated": "string",
  "ActivityEventData": {},
  "EmailList": {
    "Uid": "string",
    "_objectType": "string",
    "Created": "string",
    "Updated": "string",
    "ActivityEventData": {},
    "Name": "string",
    "Description": "string",
    "WelcomeSubject": "string",
    "WelcomeBody": "string",
    "WelcomeFromName": "string",
    "WelcomeFromEmail": "string",
    "RequiresDoubleOptIn": false,
    "IsInternal": false,
    "EmailListPerson": [],
    "FieldConfigurationDataJSON": "string",
    "CountSubscriptionsActive": 0,
    "CountSubscriptionsBounce": 0,
    "CountSubscriptionsIssues": 0,
    "CountSubscriptionsNotConfirmed": 0,
    "CountSubscriptionsSpam": 0,
    "CountSubscriptionsUnsubscribed": 0
  },
  "Person": {
    "Uid": "string",
    "_objectType": "string",
    "Created": "string",
    "Updated": "string",
    "ActivityEventData": {},
    "SchemaLessData": {},
    "Email": "string",
    "FirstName": "string",
    "LastName": "string",
    "MailingAddress": {},
    "PasswordLastUpdated": "string",
    "PasswordMustChange": false,
    "PhoneMobile": "string",
    "PhoneWork": "string",
    "ProfileImageS3Url": "string",
    "Title": "string",
    "Timezone": "string",
    "Language": "string",
    "IPAddress": "string",
    "Referer": "string",
    "UserAgent": "string",
    "LastLoginDateTime": "string",
    "OAuthGoogleProfileId": "string",
    "PersonAccount": [],
    "DealPeople": [],
    "LeadFormSubmissions": [],
    "Account": {},
    "AccountUids": "string",
    "EmailListPerson": [],
    "FullName": "string",
    "HasLoggedIn": false,
    "OAuthIntegrationStatus": 0,
    "OptInToEmailList": false,
    "Password": "string",
    "RecaptchaToken": "string",
    "UserAgentPlatformBrowser": "string",
    "HasUnsubscribed": false,
    "DiscordUser": {},
    "IsConnectedToDiscord": false
  },
  "EmailListSubscriberStatus": 1,
  "SubscribedDate": "string",
  "ConfirmedDate": "string",
  "ConfirmationNotes": "string",
  "UnsubscribedDate": "string",
  "CleanedDate": "string",
  "WelcomeEmailDeliverDateTime": "string",
  "WelcomeEmailOpenDateTime": "string",
  "UnsubscribeReason": "string",
  "UnsubscribeReasonOther": "string",
  "RecaptchaToken": "string",
  "RecaptchaSiteKey": "string",
  "SendWelcomeEmail": false,
  "Source": "string"
}

Response