Create an email list.

Name is required and must be unique. Set RequiresDoubleOptIn to true to require new subscribers to confirm their subscription. WelcomeSubject and WelcomeBody configure an optional welcome email; use WelcomeFromName and WelcomeFromEmail to set its sender.

post/api/v1/email/lists

Request

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

Request body

Uidstring nullable

_objectTypestring nullable

Createdstring date-time required

Updatedstring date-time required

ActivityEventDataunknown

Namestring required

Descriptionstring nullable

WelcomeSubjectstring nullable

WelcomeBodystring nullable

WelcomeFromNamestring nullable

WelcomeFromEmailstring nullable

RequiresDoubleOptInboolean

IsInternalboolean

FieldConfigurationDataJSONstring nullable

CountSubscriptionsActiveinteger

CountSubscriptionsBounceinteger

CountSubscriptionsIssuesinteger

CountSubscriptionsNotConfirmedinteger

CountSubscriptionsSpaminteger

CountSubscriptionsUnsubscribedinteger

Example request

{
  "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": [
    {
      "Uid": "string",
      "_objectType": "string",
      "Created": "string",
      "Updated": "string",
      "ActivityEventData": {},
      "EmailList": {},
      "Person": {},
      "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"
    }
  ],
  "FieldConfigurationDataJSON": "string",
  "CountSubscriptionsActive": 0,
  "CountSubscriptionsBounce": 0,
  "CountSubscriptionsIssues": 0,
  "CountSubscriptionsNotConfirmed": 0,
  "CountSubscriptionsSpam": 0,
  "CountSubscriptionsUnsubscribed": 0
}

Response