Skip to content

Latest commit

 

History

History
14534 lines (13637 loc) · 327 KB

schema.md

File metadata and controls

14534 lines (13637 loc) · 327 KB

Schema Types

Table of Contents

Query

Field Argument Type Description
myUser User
account Account
users [User!]
user User
id String!
accountGroups [AccountGroup!]
accountGroup AccountGroup
id String!
accountPlans [AccountPlan]!
accountPaymentMethod AccountPaymentMethod
id String!
accountPaymentMethods [AccountPaymentMethod!]
accountInvoice AccountInvoice
id String!
accountInvoices [AccountInvoice!]
accountDedicatedIps [AccountIp!]
accountReactivationCosts ReactivationCosts
permissions [Permission!]
userInvites [Invite!]
where InviteFilterInput
servicePlan ServicePlan
id String!
servicePlans [ServicePlan!]
where ServicePlanFilterInput
senderDomain SenderDomain
id String!
senderDomains [SenderDomain!]
currentSelector String
templatesInformation [TemplateInformationViewModel!]
input GetAllTemplatesInfoInput!
templates [TemplateInformationViewModel!]
input GetAllTemplatesInput!
template Template
id String!
templateContent Template
input GetTemplateContentInput!
templateVersions TemplateVersions
id String!
templateViews [TemplateView!]
templateView TemplateView
id String!
tags [Tag!]!
resourceType ResourceType
subscriberList SubscriberList
id String!
subscriberLists [SubscriberList!]
input GetAllSubscriberListsInput!
subscriberListView SubscriberListView
id String!
subscriberListViews [SubscriberListView!]
subscriberListDateField DataField
id String!
subscriberListDataFields [DataField!]
subscriberListExport Export
input GetExportInput!
subscriberListExports [Export!]
subscriberListId String!
subscriberListGroup Group
id String!
subscriberListGroups [Group!]
subscriberConversations [SubscriberConversation!]
subscriberId String!
subscriberNotes [SubscriberNote!]
subscriberId String!
subscriber Subscriber
id String!
subscribers [Subscriber!]
subscriberListId String!
subscriberListForm SubscriberListForm
id String!
subscriberListForms [SubscriberListForm!]
subscriberListId String!
formQuestion FormQuestion
input GetQuestionInput!
formQuestions [FormQuestion!]
formId String!
folders [Folder!]
file File!
id String!
files [FileInfo!]!
input GetAllFilesInput!
article Article
articleId String!
articleContent Article!
input GetArticleContentInput!
categories [Category!]!
fileView FileView
id String!
fileViews [FileView!]
campaignView CampaignView
id String!
campaignViews [CampaignView!]

Mutation

Field Argument Type Description
subscriberListImport Import
id String!
subscriberListImports [Import!]
createAccount Account
input CreateAccountInput!
updateAccount Account
input UpdateAccountInput!
updateAccountStatus Boolean
input UpdateAccountStatusInput!
createAccountGroup AccountGroup
input CreateAccountGroupInput!
updateAccountGroup AccountGroup
input UpdateAccountGroupInput!
deleteAccountGroup Boolean
id String!
createUserAccountGroup AccountGroup
input CreateUserAccountGroupInput!
deleteUserAccountGroup AccountGroup
input DeleteUserAccountGroupInput!
changeAccountPlan ChangePlanResult
input ChangeAccountPlanInput!
createAccountPaymentMethod AccountPaymentMethod
input CreatePaymentMethodInput!
updateAccountPaymentMethod AccountPaymentMethod
input UpdatePaymentMethodInput!
deleteAccountPaymentMethod Boolean
id String!
calculateAccountPlanCost CalculatedPlanCost
input CalculateAccountPlanCostInput!
submitAccountPayment AccountReceipt
input SubmitAccountPaymentInput!
cancelAccountPlanDowngrade Boolean
planId String!
updateUser User
input UpdateUserInput!
createUserInvite Invite
input CreateUserInviteInput!
resendUserInvite Invite
id String!
processUserInvite Invite
id String!
revokeUserInvite Invite
id String!
createTag Tag!
input CreateTagInput!
deleteTag Boolean!
input DeleteTagInput!
createSenderDomain SenderDomain
input CreateSenderDomainInput!
updateSenderDomain SenderDomain
id String!
sendDomainInfoEmail Boolean
input SendDomainInfoInput!
verifySenderDomain VerifyDomainResult
input VerifySenderDomainInput!
deleteSenderDomain Boolean
id String!
createTransaction [TransactionResponse!]
input CreateTransactionInput!
createTemplate Template
input CreateTemplateInput!
autoSaveTemplate Boolean
input AutoSaveTemplateInput!
updateTemplate Template
input UpdateTemplateInput!
deleteTemplate Boolean
id String!
createTemplateView TemplateView
input CreateTemplateViewInput!
updateTemplateView TemplateView
input UpdateTemplateViewInput!
deleteTemplateView Boolean
id String!
createSubscriberList SubscriberList
input CreateSubscriberListInput!
updateDoubleOptInContent Boolean
input UpdateDoubleOptInContentInput!
updateSubscriberList SubscriberList
input UpdateSubscriberListInput!
createSubscriberListSecurityGroup SubscriberList
input CreateSubscriberListSecurityGroupInput!
deleteSubscriberList Boolean
id String!
deleteSubscriberListSecurityGroup SubscriberList
input DeleteSubscriberListSecurityGroupInput!
createSubscriberListView SubscriberListView
input CreateSubscriberListViewInput!
updateSubscriberListView SubscriberListView
input UpdateSubscriberListViewInput!
deleteSubscriberListView Boolean
id String!
createSubscriberListDataField DataField
input CreateDataFieldInput!
updateSubscriberListDataField DataField
input UpdateDataFieldInput!
deleteSubscriberListDataField Boolean
input DeleteDataFieldInput!
createExport Export
input CreateExportInput!
createSubscriberListGroup Group
input CreateGroupInput!
updateSubscriberListGroup Group
input UpdateGroupInput!
deleteSubscriberListGroup Boolean
input DeleteGroupInput!
createSubscriberListImport Boolean
input CreateImportInput!
createSubscriberConversation Subscriber
input CreateSubscriberConversationInput!
createSubscriberNote Subscriber
input CreateSubscriberNoteInput!
deleteSubscriberNote Boolean
input DeleteSubscriberNoteInput!
createSubscriber Subscriber
input CreateSubscriberInput!
updateSubscriber Subscriber
input UpdateSubscriberInput!
updateSubscriberStatus Subscriber
input ChangeSubscriberStatusInput!
createGroupSubscriber Subscriber
id String!
deleteGroupSubscriber Subscriber
id String!
deleteSubscriber Boolean
id String!
createForm SubscriberListForm
input CreateFormInput!
publishForm Boolean
input PublishFormInput!
unpublishForm SubscriberListForm
id String!
updateForm SubscriberListForm
input UpdateSubscriberListFormInput!
updateFormDialog SubscriberListForm
input UpdateSubscriberListFormDialogInput!
updateFormPage SubscriberListForm
input UpdateSubscriberListFormPageInput!
exportForm String
input ExportFormInput!
deleteForm Boolean
input DeleteFormInput!
createFormQuestion FormQuestion
input CreateQuestionInput!
updateFormQuestion FormQuestion
input UpdateQuestionInput!
deleteFormQuestion Boolean
id String!
createFolder Folder
input CreateFolderInput!
updateFolder Folder
input UpdateFolderInput!
deleteFolder Boolean
id String!
createUrlFile File
input CreateUrlFileInput!
updateFile File
input UpdateFileInput!
deleteFile Boolean
id String!
createCategory Category!
input CreateCategoryInput!
deleteCategory Boolean!
input DeleteCategoryInput!
createFileView FileView
input CreateFileViewInput!
updateFileView FileView
input UpdateFileViewInput!
deleteFileView Boolean
id String!
createArticle Article
input CreateArticleInput!
autoSaveArticle Boolean
input AutoSaveArticleInput!
updateArticle Article
input UpdateArticleInput!
deleteArticle Boolean
id String!
createCampaignView CampaignView
input CreateCampaignViewInput!
updateCampaignView CampaignView
input UpdateCampaignViewInput!
deleteCampaignView Boolean
id String!

Objects

Account

Field Argument Type Description
id String!
settings [AccountSetting!]
users [User!]
owner User
status AccountStatus!
isStatusChangeable Boolean!
lastStatusChangedUtc DateTime
name String!
paymentStatus PaymentStatus
streetAddressLine1 String!

Gets or sets the address.
streetAddressLine2 String

Gets or sets the address2.
city String!

Gets or sets the city.
state_Province String!

Gets or sets the region.
zip_PostalCode String

Gets or sets the postal code.
country_Region String!

Gets or sets the country.
website String

Gets or sets the website url.
phone String!
createdUtc DateTime!
createdBy String!
modifiedUtc DateTime!
modifiedBy String!
groups [AccountGroup!]!
senderDomains [SenderDomain!]!
invites [Invite!]!
dedicatedIps [AccountIp!]!

AccountGroup

Field Argument Type Description
id String!
name String
users [User!]!
permissions [Permission!]!
userCount Int!
description String
isActive Boolean!
isAdmin Boolean!
createdUtc DateTime!
createdBy String
modifiedUtc DateTime!
modifiedBy String
lists [List]

AccountGroupPermission

Field Argument Type Description
description String!
accountId Long!
permissionKey String
permissionId Long!
groupId Long!
group AccountGroup

AccountInvoice

Field Argument Type Description
id String!
status InvoiceStatus!
pdfUrl String!
orderNbr String
amount Float!
totalAmount Float!
servicePeriodStartUtc DateTime!
servicePeriodEndUtc DateTime!
dueUtc DateTime!
createdUtc DateTime!
createdBy String
modifiedUtc DateTime!
modifiedBy String
lineItems [AccountInvoiceLineItem]
receipts [AccountReceipt]

AccountInvoiceLineItem

Field Argument Type Description
id String!
serviceType ServiceType!
description String
rate Float!
qty Float!
amount Float!
isDiscount Boolean!
createdUtc DateTime!
createdBy String
modifiedUtc DateTime!
modifiedBy String

AccountIp

Field Argument Type Description
id String!
name String
createdUtc DateTime!
createdBy String
modifiedUtc DateTime!
modifiedBy String

AccountPaymentMethod

Field Argument Type Description
id String!
billingAddress BillingAddress!
nickname String
expMonth Int!
expYear Int!
isDefault Boolean!
last4Digits String
cardNetwork CreditCardNetwork!
createdUtc DateTime!
createdBy String
modifiedUtc DateTime!
modifiedBy String

AccountPlan

Field Argument Type Description
subscriberCount Int!
emailSent Int!
creditBalance Float!
averageMonthlyCreditsUsed Float!
discounts [AccountPlanDiscount!]!
nextPlan ServicePlan
id String!
servicePlanId String!
serviceType ServiceType!
description String!
name String!
fee Float!
minSubscribers Int!
maxSubscribers Int!
qty Float!
currBillPeriodStartUtc DateTime!
nextBillUtc DateTime!
isMonthly Boolean!
isTrial Boolean!
trialEndUtc DateTime
autoRefillCredits Float!
minimumCredits Float!
features [AccountPlanFeature!]!

AccountPlanDiscount

Field Argument Type Description
id String!
name String!
description String
discountAmt Float!
discountPct Float!
isRecurring Boolean!
startUtc DateTime!
nextUtc DateTime!
endUtc DateTime
createdUtc DateTime!
createdBy String
modifiedUtc DateTime!
modifiedBy String

AccountPlanFeature

Field Argument Type Description
id String!
name String!
description String!
limit Int!
limitDescription String!

AccountReceipt

Field Argument Type Description
id String!
invoiceId String!
transactionId String
amount Float!
reason CardDeclineReason!
status PaymentStatus!
paymentNickname String
paymentExpMonth Int
paymentExpYear Int
paymentLast4Digits String
paymentCardNetwork CreditCardNetwork
createdUtc DateTime!
createdBy String

AccountSetting

Field Argument Type Description
id String!
name String!
description String!
value String!

Article

Field Argument Type Description
id String!
folderId String!
name String!
title String
language String
recoveryFile Boolean!
defaultLayout ArticleDefaultLayout
category String
description String
createdUtc DateTime!
modifiedUtc DateTime!
publishedUtc DateTime
tags [String!]
versions [Version!]!
contentBodies [ArticleContent!]

ArticleContent

Field Argument Type Description
mimeType MimeType!
content String!

BillingAddress

Field Argument Type Description
firstName String!
lastName String!
emailAddr String!
streetAddressLine1 String!
streetAddressLine2 String!
city String!
state_Province String!
zip_PostalCode String!
country_Region String!
phone String!

CalculatedItem

Field Argument Type Description
serviceType ServiceType!
isCurrentPlan Boolean!
proratedFee Float!
totalFee Float!
discountAmt Float!
discountPct Float!

CalculatedPlanCost

Field Argument Type Description
items [CalculatedItem!]!
effectiveUtc DateTime!
nextBillingUtc DateTime!

CampaignView

Field Argument Type Description
id String!
name String
sendStartUtc DateTime
sendEndUtc DateTime
modifiedStartUtc DateTime
modifiedEndUtc DateTime
createdStartUtc DateTime
createdEndUtc DateTime
groupBy CampaignFields
sortBy CampaignFields
isPrivate Boolean!
tags [String]
statuses [CampaignSendStatus!]
createdBy String
createdUtc DateTime!
modifiedBy String
modifiedUtc DateTime!

Category

Field Argument Type Description
categoryName String

ChangePlanResult

Field Argument Type Description
successful Boolean!
failedPaymentReason CardDeclineReason
receipt AccountReceipt

Column

Field Argument Type Description
subscribers DataField!
skip Boolean!

Condition

Field Argument Type Description
id String!
dataField DataField!
conditionGroup ConditionGroup!
fieldName String
operator Operator!
value String

ConditionGroup

Field Argument Type Description
id String!
parentConditionGroup ConditionGroup!
operator ConditionGroupOperator!
conditions [Condition]
childConditionGroups [ConditionGroup]

DataField

Field Argument Type Description
id String!
dataType DataType!
labelText String
dscr String
required Boolean!
isPublic Boolean!
mergeTag String
defaultValue String
possibleValues [DataFieldValue]
valueType FieldValueType!
minNbr Decimal
maxNbr Decimal
minUtc DateTime
maxUtc DateTime
allowOther Boolean!
monthDayFormat Boolean!
conditions [Condition]
createdUtc DateTime!
createdBy String
modifiedUtc DateTime!
modifiedBy String

DataFieldLanguageLabel

Field Argument Type Description
id Long!
language String
label String

DataFieldValue

Field Argument Type Description
id String!
label String
value String
displayOrder Int!
languageLabels [DataFieldLanguageLabel]

Email

Field Argument Type Description
domain String

255 character limit
localPart String

65 character limit

Export

Field Argument Type Description
id String!
name String
notificationEmail Email
subscriberStatus SubscriberStatus!
groupIds [String]
behaviors [String]
fields [String]
delimiter FileDelimiter!
status ExportStatus!
dataLocationUrl String
subscriberListId Long!
createdUtc DateTime!
createdBy String

File

Field Argument Type Description
id String!
name String!
publicUrl String!
thumbnailUrl String!
size Int!
uploadedUtc DateTime!
tags [String!]!

FileInfo

Field Argument Type Description
id String!
name String!
thumbnailUrl String!
publicUrl String!
type FileType!
size Int!
tags [String!]!
createdUtc DateTime!
modifiedUtc DateTime!

FileView

Field Argument Type Description
id String!
name String
modifiedStartUtc DateTime
modifiedEndUtc DateTime
createdStartUtc DateTime
createdEndUtc DateTime
groupBy FileFields
sortBy FileFields
isPrivate Boolean!
createdBy String
createdUtc DateTime!
modifiedBy String
modifiedUtc DateTime!
tags [String]
types [FileType!]

Folder

Field Argument Type Description
id String!
parentId String
name String!
hasChildren Boolean!

Form

Field Argument Type Description
id Long!
name String
type FormType!
isPublished Boolean!
publishedUtc DateTime
answeredCount Int!
visitedCount Int!
skipped Int!
submissionAction FormAction!
sendThankYouEmail Boolean!
sendNotificationEmail Boolean!
notificationAttachmentFormat FormAttachmentFormat!
duplicateEmailAction FormDuplicateEmailAction!
duplicationEmailMessageAction FormAction!
createdUtc DateTime!
createdBy String
modifiedUtc DateTime!
modifiedBy String
accountId Long!
subscriberListId Long!
subscriberList SubscriberList
notifications [Notification]
questions [FormQuestion]
events [FormEvent]

FormAnswer

Field Argument Type Description
question FormQuestion
answerText String
comment String
subscriberId String
sourceId String
sourceType EventSourceType

FormDialog

Field Argument Type Description
type FormDialogType!
message String!
thankYouIcon FormDialogIcon!
iconColor String!
displayRedirectButton Boolean!
redirectButtonText String!
redirectButtonUrl String!
redirectButtonColor String!
showRedirectButton Boolean!
buttonText String!
redirectUrl String!
displayCloseButton Boolean!
displayResults Boolean!
displayAnswers Boolean!

FormEvent

Field Argument Type Description
id Long!
respondentId Long!
eventUtc DateTime!
eventType FormEventType!
readSeconds Int!
ipAddress [Byte!]
software String
os String
device String
userAgent String
campaignId Long
accountId Long!
createdUtc DateTime!
createdBy String
modifiedUtc DateTime!
modifiedBy String
subscriberId Long
subscriber Subscriber
formId Long!
form Form

FormPage

Field Argument Type Description
type FormPageType!
content String!

FormQuestion

Field Argument Type Description
id Long!
text String
type QuestionType!
required Boolean!
answeredCount Int!
skippedCount Int!
display Boolean!
isActive Boolean!
characterLimit Int
displayOrder Int!
createdBy String
createdUtc DateTime!
modifiedBy String
modifiedUtc DateTime!
accountId Long!
parentQuestionId Long
formId Long!
form Form
answers [FormQuestionAnswer]

FormQuestionAnswer

Field Argument Type Description
id Long!
text String
displayOrder Int!
createdBy String
createdUtc DateTime!
modifiedBy String
modifiedUtc DateTime!
accountId Long!
questionId Long!
question FormQuestion

FormResponse

Field Argument Type Description
collector String
submissionUtc DateTime!
timeSpentMinutes Float!
answers [FormAnswer]
createdUtc DateTime!

Group

Field Argument Type Description
id String!
subscribers [Subscriber!]!
name String
description String
isPublic Boolean!
isDynamic Boolean!
totalSubscribers Int!
totalActiveSubscribers Int!
totalUnconfirmedSubscribers Int!
totalUndeliverableSubscribers Int!
totalUnsubscribedSubscribers Int!
totalComplaintSubscribers Int!
createdUtc DateTime!
createdBy String
modifiedUtc DateTime!
modifiedBy String

Import

Field Argument Type Description
id String!
groups [Group!]!
columns [Column]
deleteArea ImportDeleteArea!
update Boolean!
unsubscribe Boolean!
skipFirstRow Boolean!
confirmEmail String
delimiter FileDelimiter!
status ImportStatus!
FileRecords Int!
recordsAdded Int!
recordsUpdated Int!
badRecords Int!
duplicateRecords Int!
jobStartedUtc DateTime
jobEndedUtc DateTime
ErrorCode String
createdUtc DateTime!
createdBy String
modifiedUtc DateTime!
modifiedBy String

Invite

Field Argument Type Description
id String!
firstName String!
lastName String!
status InviteStatus!
emailAddr String!
groups [AccountGroup!]
user User
account Account
createdUtc DateTime!

List

Field Argument Type Description
listId String!
createdUtc DateTime!
createdBy String
modifiedUtc DateTime!
modifiedBy String

Notification

Field Argument Type Description
id Long!
subscriberListMessageType SubscriberListMessageType!
enabled Boolean!
fromText String
fromEmail Email
subject String
notificationContents [NotificationContent]
formId Long!
createdUtc DateTime!
createdBy String
modifiedUtc DateTime!
modifiedBy String
accountId Long!

NotificationContent

Field Argument Type Description
id Long!
mimeType String
dataBlobId String
workingDataBlobId String
recoveryDataBlobId String
thumbnailUrl String
validContent Boolean!
autoSaveUtc DateTime
notificationId Long!
notification Notification
createdUtc DateTime!
createdBy String
modifiedUtc DateTime!
modifiedBy String
accountId Long!

Permission

Field Argument Type Description
id String!
name String
key String
description String

ProfileField

Field Argument Type Description
id String!
datafield DataField!
value String!
valueType RawDataType!
createdUtc DateTime!
createdBy String
modifiedUtc DateTime!
modifiedBy String

ReactivationCosts

Field Argument Type Description
previousCost Float!
newCost Float!
dueNow Float!
currentCost Float!

SenderDomain

Field Argument Type Description
id String!
domain String
dkimSelector String
dkimValid Boolean!
dkimReason String
dmarcValid Boolean!
dmarcReason String
lastVerifiedUtc DateTime!
lastVerifiedResults String
createdUtc DateTime!
createdBy String
modifiedUtc DateTime!
modifiedBy String

ServicePlan

Field Argument Type Description
id String!
name String!
description String!
serviceType ServiceType!
creditValue Float!
_do Int!

Internal use only
scales [ServicePlanScale!]!
credits [ServicePlanCredit!]!
features [ServicePlanFeature!]!

ServicePlanCredit

Field Argument Type Description
id String!
qty Float!
fee Float!

ServicePlanFeature

Field Argument Type Description
id String!
name String!
description String!
limit Int!
limitDescription String!
_do Int!

Internal use only

ServicePlanScale

Field Argument Type Description
id String!
minLimit Int!
maxLimit Int!
fee Float!

Subscriber

Field Argument Type Description
id String!
optInIp String
confirmedIp String
optOutIp String
groups [Group!]!
tags [Tag!]!
rating Decimal
longitude Decimal
latitude Decimal
city String
state String
postalCode String
country String
timeZone String
cultureCode String
sendFormat SendFormat!
status SubscriberStatus!
email Email
optInUtc DateTime
optInSource OptInSource!
confirmedUtc DateTime
optOutUtc DateTime
optOutSource OptOutSource!
optOutReason String
conversations [SubscriberConversation]
notes [SubscriberNote]
profileFields [ProfileField]
events [SubscriberEvent]
createdUtc DateTime!
createdBy String
modifiedUtc DateTime!
modifiedBy String

SubscriberConversation

Field Argument Type Description
id String!
fromSubscriber Boolean!
message String
status Status!
createdUtc DateTime!
createdBy String
modifiedUtc DateTime!
modifiedBy String

SubscriberEvent

Field Argument Type Description
id String!
sourceId String!
sourceLinkId String!
ipAddress String
eventUtc DateTime!
eventType EmailEventType!
readSeconds Int
sourceType EventSourceType!

SubscriberList

Field Argument Type Description
id String!
name String
CompanyName String
address1 String
address2 String
city String
state String
zipCode String
country String
phone String
website String
defaultFromEmail Email
defaultFromText String
requireDoubleOptIn Boolean!
totalSubscribers Int!
totalActiveSubscribers Int!
totalUnconfirmedSubscribers Int!
totalUndeliverableSubscribers Int!
totalUnsubscribedSubscribers Int!
totalComplaintSubscribers Int!
totalScrubbedSubscribers Int!
dataFields [DataField]
groups [Group]
subscribers [Subscriber]
imports [Import]
exports [Export]
tags [SubscriberListTag]
forms [Form]
createdUtc DateTime!
createdBy String
modifiedUtc DateTime!
modifiedBy String

SubscriberListForm

Field Argument Type Description
id String!
name String!
sharableUrl String!
answeredCount Int!
visitedCount Int!
skippedCount Int!
published Boolean!
publishedUtc DateTime!
pageName String!
pageTitle String!
metaDescription String!
metaKeywords [String!]!
socialStoryImageUrl String!
defaultLanguage String!
translationLanguages [String!]!
requiredTextTranslation String!
formErrorTextTranslation String!
redirectUrl String
submitAction FormAction!
sendThankYou Boolean!
groups [Group!]!
tags [String!]!
sendNotificationEmail Boolean!
attachmentFormat FormAttachmentFormat!
duplicateEmailAction FormDuplicateEmailAction!
duplicateEmailErrorAction FormAction!
duplicateEmailErrorRedirectUrl String
subscriberListId String!
modifiedUtc DateTime!
dialogs [FormDialog!]!
pages [FormPage!]!
questions [FormQuestion!]!
responses [FormResponse!]!

SubscriberListTag

Field Argument Type Description
tagHash [Byte!]
tag Tag
subscriberListId Long!
subscriberList SubscriberList
accountId Long!

SubscriberListView

Field Argument Type Description
id String!
name String
minOpenRate Float
maxOpenRate Float
minClickRate Float
maxClickRate Float
groupBy String
sortBy String
isPrivate Boolean!
userId Long
createdBy String
createdUtc DateTime!
modifiedBy String
modifiedUtc DateTime!
tags [String]

SubscriberNote

Field Argument Type Description
id String!
message String
status Status!
createdUtc DateTime!
createdBy String
modifiedUtc DateTime!
modifiedBy String

Tag

Field Argument Type Description
tagName String

Template

Field Argument Type Description
usage TemplateUsage
versionInfo TemplateVersions!
id String!
name String!
description String!
tags [String!]
type TemplateType!
category TemplateCategory!
createdUtc DateTime!
modifiedUtc DateTime!
contentBodies [TemplateContent!]!

TemplateCampaign

Field Argument Type Description
name String!
status CampaignSendStatus!
sentUtc DateTime

TemplateContent

Field Argument Type Description
type MimeType!
content String!

TemplateInformationViewModel

Field Argument Type Description
id String!
name String!
description String!
thumbnailUrl String!
lastModifiedUtc DateTime!
tags [String!]!
type TemplateType!
category TemplateCategory!
subcategory TemplateSubCategory!

TemplateUsage

Field Argument Type Description
sentCampaigns Int!
draftCampaigns Int!
campaigns [TemplateCampaign!]!

TemplateVersion

Field Argument Type Description
id String!
lastModifiedUtc DateTime!

TemplateVersions

Field Argument Type Description
versions [TemplateVersion!]!
recoveryFile Boolean!

TemplateView

Field Argument Type Description
id String!
name String
modifiedStartUtc DateTime
modifiedEndUtc DateTime
createdStartUtc DateTime
createdEndUtc DateTime
groupBy TemplateFields
sortBy TemplateFields
isPrivate Boolean!
userId Long
createdBy String
createdUtc DateTime!
modifiedBy String
modifiedUtc DateTime!
tags [String]
types [TemplateType!]

TransactionResponse

Field Argument Type Description
transactionId String!
requestId String!
emailAddress String!
errorCode String!
errorMsg String!

User

Field Argument Type Description
id String!
accounts [Account!]
groups [AccountGroup!]!
settings [UserSetting!]!
permissions [Permission!]!
status UserStatus!
firstName String
lastName String
company String
businessPhone String
mobilePhone String
otherPhone String
emailAddr String!
mfaEnabled Boolean!
createdUtc DateTime!
createdBy String!
modifiedUtc DateTime!
modifiedBy String!

UserSetting

Field Argument Type Description
id String!
name String!
description String!
value String!

VerifyDomainResult

Field Argument Type Description
lastVerifiedUtc DateTime!
dkimValid Boolean!
dkimReason String!
dmarcValid Boolean!
dmarcReason String!

Version

Field Argument Type Description
id Float!
lastModifiedUtc DateTime!

Inputs

AddBillingAddressInput

Field Type Description
firstName String!

100 character limit
lastName String!

100 character limit
emailAddr String!

320 character limit
streetAddressLine1 String!

100 character limit
streetAddressLine2 String

50 character limit
city String!

100 character limit
state_Province String!

100 character limit
zip_PostalCode String!

15 character limit
country_Region String!

100 character limit
phone String!

25 character limit

AddCreditCardInfoInput

Field Type Description
cardNumber String!

Needs to be a 13-16 digit value
expirationMonth Int!

1-12
expirationYear Int!

yyyy format (ex: 2021)
cvv Int!

3 or 4 digit number

AutoSaveArticleContentInput

Field Type Description
mimeType MimeType!
content String!

AutoSaveArticleInput

Field Type Description
id String!
contentBodies [AutoSaveArticleContentInput!]!

AutoSaveTemplateContentInput

Field Type Description
mimeType MimeType!
content String!

AutoSaveTemplateInput

Field Type Description
id String!
contentBodies [AutoSaveTemplateContentInput!]!

CalculateAccountPlanCostInput

Field Type Description
currentPlanId String!
newPlanId String!
newCreditItemId String!

Should be set to '0' if the new plan a monthly plan.

ChangeAccountPlanInput

Field Type Description
newPlanId String!
newCreditItemId String

Should be set to 0 or null if new plan is monthly.
paymentMethodId String!
autoRefillCreditItemId String
minimumCredits Float

ChangeSubscriberStatusInput

Field Type Description
id String!
status SubscriberStatus!

ComparableDateTimeOperationFilterInput

Field Type Description
eq DateTime
neq DateTime
in [DateTime!]
nin [DateTime!]
gt DateTime
ngt DateTime
gte DateTime
ngte DateTime
lt DateTime
nlt DateTime
lte DateTime
nlte DateTime

ComparableDoubleOperationFilterInput

Field Type Description
eq Float
neq Float
in [Float!]
nin [Float!]
gt Float
ngt Float
gte Float
ngte Float
lt Float
nlt Float
lte Float
nlte Float

ComparableInt32OperationFilterInput

Field Type Description
eq Int
neq Int
in [Int!]
nin [Int!]
gt Int
ngt Int
gte Int
ngte Int
lt Int
nlt Int
lte Int
nlte Int

ComparableInt64OperationFilterInput

Field Type Description
eq Long
neq Long
in [Long!]
nin [Long!]
gt Long
ngt Long
gte Long
ngte Long
lt Long
nlt Long
lte Long
nlte Long

ConditionGroupInput

Field Type Description
operator ConditionGroupOperator!
conditions [ConditionInput!]!
conditionGroups [ConditionGroupInput!]!

ConditionInput

Field Type Description
fieldName String
dataFieldId String!
operator Operator!
value String

CreateAccountGroupInput

Field Type Description
name String!

100 character limit
description String

255 character limit
permissionKeys [String!]!
lists [String!]

CreateAccountInput

Field Type Description
name String!

Unique name to reference the account. Max length: 255
streetAddressLine1 String!

100 character limit
streetAddressLine2 String

50 character limit
city String!

100 character limit
state_Province String!

100 character limit
zip_PostalCode String!

15 character limit
country_Region String!

100 character limit
phone String!

25 character limit
website String

255 character limit
defaultLanguage String

Must be a valid culture code or set to "Auto".
defaultTimezone String

Must be a valid IANA timezone or set to "Auto".

CreateArticleContentInput

Field Type Description
mimeType MimeType!
content String!

CreateArticleInput

Field Type Description
folderId String!
name String!

100 character limit
title String

100 character limit
language String

Must be a valid culture code or set to "Auto".
defaultLayout ArticleDefaultLayout
category String

50 character limit
description String

255 character limit
tags [String!]
contentBodies [CreateArticleContentInput!]

CreateCampaignViewInput

Field Type Description
name String!
tags [String!]
statuses [CampaignSendStatus!]
sendStartUtc DateTime
sendEndUtc DateTime
modifiedStartUtc DateTime
modifiedEndUtc DateTime
createdStartUtc DateTime
createdEndUtc DateTime
groupBy CampaignFields
sortBy CampaignFields
isPrivate Boolean!

CreateCategoryInput

Field Type Description
categoryName String!

CreateDataFieldInput

Field Type Description
dataType DataType!
fieldName String!

50 character limit
dscr String

200 character limit
required Boolean!
isPublic Boolean!
mergeTag String

50 character limit
defaultValue String!

255 character limit
possibleValues [CreateDataFieldValueInput!]!
valueType FieldValueType!
minNbr Decimal
maxNbr Decimal
minDate DateTime
maxDate DateTime
allowOther Boolean!
monthDayFormat Boolean!
subscriberListId String!

CreateDataFieldLanguageLabelInput

Field Type Description
language String!

Must be a valid culture code.
label String!

100 character limit

CreateDataFieldValueInput

Field Type Description
language String!
label String!

100 character limit
value String!

100 character limit
languageLabels [CreateDataFieldLanguageLabelInput!]
displayOrder Int!

CreateExportInput

Field Type Description
subscriberListId String!
name String!

100 character limit
notificationEmail String!

320 character limit
delimiter FileDelimiter!
subscriberStatus SubscriberStatus!
entireList Boolean!
allFields Boolean!
allBehaviors Boolean!
groupIds [String!]
fields [String!]
behaviors [String!]

CreateFileViewInput

Field Type Description
name String!
tags [String!]
types [FileType!]
modifiedStartUtc DateTime
modifiedEndUtc DateTime
createdStartUtc DateTime
createdEndUtc DateTime
groupBy FileFields
sortBy FileFields
isPrivate Boolean!

CreateFolderInput

Field Type Description
parentId String!
name String!

50 character limit

CreateFormInput

Field Type Description
name String!

100 character limit
type FormType!
subscriberListId String

CreateGroupInput

Field Type Description
name String!

100 character limit
description String

255 character limit
isPublic Boolean!
isDynamic Boolean!
sourceGroupIds [String!]!

Use to combine groups previously created
criteria ConditionGroupInput
subscriberListId String!

CreateGroupSubscriberInput

Field Type Description
groupId String!
groupName String!

CreateImportInput

Field Type Description
subscriberListId String!
dataFileId String!
groups [String!]!
columns [DataColumnInput!]!
deleteArea ImportDeleteArea!
update Boolean!
unsubscribe Boolean!
skipFirstRow Boolean!
confirmEmail String!

320 character limit
delimiter FileDelimiter!

CreatePaymentMethodInput

Field Type Description
nickname String!

100 character limit
isDefault Boolean!
creditCardInfo AddCreditCardInfoInput!
billingAddress AddBillingAddressInput!

CreateProfileFieldInput

Field Type Description
dataFieldId String!
labelText String!

CreateQuestionCategoryInput

Field Type Description
text String!
answers [String!]!

CreateQuestionInput

Field Type Description
type QuestionType!
text String!
dataFieldId String
required Boolean!
display Boolean!
displayOrder Int!
categories [CreateQuestionCategoryInput!]!
answers [String!]

CreateSenderDomainInput

Field Type Description
domain String!

65 character limit

CreateSubscriberConversationInput

Field Type Description
subscriberId String!
fromSubscriber Boolean!
message String!

CreateSubscriberInput

Field Type Description
subscriberIp String

Needs to be in valid Ip format (000.000.000.000)
longitude Decimal
latitude Decimal
city String

100 character limit
state_Province String

100 character limit
zip_PostalCode String

15 character limit
country_Region String

100 character limit
timeZone String!
cultureCode String!
email String!

100 character limit
sendFormat SendFormat!
optInDateTimeUtc DateTime
optInIp String!
optOutDateTimeUtc DateTime
optOutSource OptOutSource!
optOutIp String!
optOutReason String!
subscriberListId String!
groups [CreateGroupSubscriberInput!]!
profile [CreateProfileFieldInput!]!
tags [String!]!

CreateSubscriberListInput

Field Type Description
name String!

100 character limit
tags [String!]

50 character limit
companyName String!

255 character limit
streetAddressLine1 String!

100 character limit
streetAddressLine2 String

50 character limit
city String!

100 character limit
state_Province String!

100 character limit
zip_PostalCode String!

15 character limit
country_Region String!

100 character limit
phone String!

25 character limit
groupIds [String!]

CreateSubscriberListSecurityGroupInput

Field Type Description
securityGroupId String!
subscriberListId String!

CreateSubscriberListViewInput

Field Type Description
name String!
tags [String!]
minOpenRate Float
maxOpenRate Float
minClickRate Float
maxClickRate Float
groupBy String
sortBy String
isPrivate Boolean!

CreateSubscriberNoteInput

Field Type Description
subscriberId String!
message String!

255 character limit

CreateTagInput

Field Type Description
tagName String!

CreateTemplateInput

Field Type Description
referenceTemplateId String!
name String!
listId String
tags [String!]

CreateTemplateViewInput

Field Type Description
name String!
tags [String!]
types [TemplateType!]
modifiedStartUtc DateTime
modifiedEndUtc DateTime
createdStartUtc DateTime
createdEndUtc DateTime
groupBy TemplateFields
sortBy TemplateFields
isPrivate Boolean!

CreateTransactionInput

Field Type Description
groupName String

100 character limit
settings TransactionSettingsInput!
tags [String!]
metadata [NameValueInput!]
header TransactionHeaderInput!
content TransactionContentInput!
variables [NameValueInput!]
recipients [TransactionRecipientInput!]!

CreateUrlFileInput

Field Type Description
folderId String!
name String

100 character limit. If not passed, the file name will be used.
fileUrl String!
tags [String!]

50 character limit
overwrite Boolean

Defaults to false if not passed.

CreateUserAccountGroupInput

Field Type Description
id String!
groupId String!

CreateUserInviteInput

Field Type Description
firstName String!

100 character limit
lastName String!

100 character limit
emailAddress String!

320 character limit
accountGroupIds [String!]!
message String

255 character limit

DataColumnInput

Field Type Description
skip Boolean!
fieldName String!

50 character limit
dataFieldId String!

DeleteCategoryInput

Field Type Description
categoryName String!

DeleteDataFieldInput

Field Type Description
id String!
subscriberListId String!

DeleteFormInput

Field Type Description
formId String!
subscriberListId String

DeleteGroupInput

Field Type Description
id String!
subscriberListId String!

DeleteSubscriberListSecurityGroupInput

Field Type Description
securityGroupId String!
subscriberListId String!

DeleteSubscriberNoteInput

Field Type Description
id String!
subscriberId String!

DeleteTagInput

Field Type Description
tagName String!

DeleteUserAccountGroupInput

Field Type Description
id String!
groupId String!

EmailFilterInput

Field Type Description
and [EmailFilterInput!]
or [EmailFilterInput!]
domain StringOperationFilterInput

255 character limit
localPart StringOperationFilterInput

65 character limit

ExportFormInput

Field Type Description
formId String!
subscriberListId String
style FormExportStyle!
includeValidation Boolean!
includePageHtml Boolean!
includeArchiveLink Boolean!

GetAllFilesInput

Field Type Description
folderId String
fileViewId String
partialName String

50 character limit
tags [String!]
types [FileType!]
modifiedStartUtc DateTime
modifiedEndUtc DateTime
createdStartUtc DateTime
createdEndUtc DateTime
isPrivate Boolean

GetAllSubscriberListsInput

Field Type Description
partialName String
subscriberListViewId String
tags [String!]
minOpenRate Float
maxOpenRate Float
minClickRate Float
maxClickRate Float
groupBy String
sortBy String

GetAllTemplatesInfoInput

Field Type Description
category TemplateCategory!
subcategory TemplateSubCategory
type TemplateType

GetAllTemplatesInput

Field Type Description
partialName String
templateViewId String
tags [String!]
types [TemplateType!]
modifiedStartUtc DateTime
modifiedEndUtc DateTime
createdStartUtc DateTime
createdEndUtc DateTime
groupBy String
sortBy String
isPrivate Boolean

GetArticleContentInput

Field Type Description
id String
recovery Boolean

GetExportInput

Field Type Description
subscriberListId String!
id String!

GetQuestionInput

Field Type Description
id String!
formId String!

GetTemplateContentInput

Field Type Description
id String
recovery Boolean

GroupInput

Field Type Description
id Long!
name String
description String
isPublic Boolean!
isDynamic Boolean!
totalSubscribers Int!
totalActiveSubscribers Int!
totalUnconfirmedSubscribers Int!
totalUndeliverableSubscribers Int!
totalUnsubscribedSubscribers Int!
totalComplaintSubscribers Int!
groupSubscribers [GroupSubscriberInput]
createdUtc DateTime!
createdBy String
modifiedUtc DateTime!
modifiedBy String

GroupSubscriberInput

Field Type Description
subscriberId Long!
groupId Long!
group GroupInput
accountId Long!

InviteFilterInput

Field Type Description
and [InviteFilterInput!]
or [InviteFilterInput!]
id ComparableInt64OperationFilterInput
firstName StringOperationFilterInput
lastName StringOperationFilterInput
emailAddr EmailFilterInput
securityGroupIds StringOperationFilterInput
inviteStatus InviteStatusOperationFilterInput
createdUtc ComparableDateTimeOperationFilterInput
accountId ComparableInt64OperationFilterInput
userId ComparableInt64OperationFilterInput

InviteStatusOperationFilterInput

Field Type Description
eq InviteStatus
neq InviteStatus
in [InviteStatus!]
nin [InviteStatus!]

ListFilterInputTypeOfServicePlanCreditItemFilterInput

Field Type Description
all ServicePlanCreditFilterInput
none ServicePlanCreditFilterInput
some ServicePlanCreditFilterInput
any Boolean

ListFilterInputTypeOfServicePlanFeatureViewModelFilterInput

Field Type Description
all ServicePlanFeatureFilterInput
none ServicePlanFeatureFilterInput
some ServicePlanFeatureFilterInput
any Boolean

ListFilterInputTypeOfServicePlanScaleFilterInput

Field Type Description
all ServicePlanScaleFilterInput
none ServicePlanScaleFilterInput
some ServicePlanScaleFilterInput
any Boolean

NameValueInput

Field Type Description
name String!
value String!

PublishFormInput

Field Type Description
formId String!
subscriberListId String

SendDomainInfoInput

Field Type Description
domain String!

65 character limit
emailAddr String!

300 character limit

ServicePlanCreditFilterInput

Field Type Description
and [ServicePlanCreditFilterInput!]
or [ServicePlanCreditFilterInput!]
id ComparableInt64OperationFilterInput
qty ComparableDoubleOperationFilterInput
fee ComparableDoubleOperationFilterInput

ServicePlanFeatureFilterInput

Field Type Description
and [ServicePlanFeatureFilterInput!]
or [ServicePlanFeatureFilterInput!]
id StringOperationFilterInput
name StringOperationFilterInput
description StringOperationFilterInput
limit ComparableInt32OperationFilterInput
limitDescription StringOperationFilterInput
_do ComparableInt32OperationFilterInput

Internal use only

ServicePlanFilterInput

Field Type Description
and [ServicePlanFilterInput!]
or [ServicePlanFilterInput!]
id StringOperationFilterInput
name StringOperationFilterInput
description StringOperationFilterInput
serviceType ServiceTypeOperationFilterInput
creditValue ComparableDoubleOperationFilterInput
_do ComparableInt32OperationFilterInput

Internal use only
scales ListFilterInputTypeOfServicePlanScaleFilterInput
credits ListFilterInputTypeOfServicePlanCreditItemFilterInput
features ListFilterInputTypeOfServicePlanFeatureViewModelFilterInput

ServicePlanScaleFilterInput

Field Type Description
and [ServicePlanScaleFilterInput!]
or [ServicePlanScaleFilterInput!]
id ComparableInt64OperationFilterInput
minLimit ComparableInt32OperationFilterInput
maxLimit ComparableInt32OperationFilterInput
fee ComparableDoubleOperationFilterInput

ServiceTypeOperationFilterInput

Field Type Description
eq ServiceType
neq ServiceType
in [ServiceType!]
nin [ServiceType!]

StringOperationFilterInput

Field Type Description
and [StringOperationFilterInput!]
or [StringOperationFilterInput!]
eq String
neq String
contains String
ncontains String
in [String]
nin [String]
startsWith String
nstartsWith String
endsWith String
nendsWith String

SubmitAccountPaymentInput

Field Type Description
invoiceId String!
paymentMethodId String!

TransactionAnalyticsInput

Field Type Description
enable Boolean!
parameters [NameValueInput!]

Name: 50 character limit Value: 50 character limit
domains [TransactionDomainAnalyticsInput!]

TransactionContentBodyInput

Field Type Description
clickTracking Boolean
charset Charset
mimeType MimeType!
bodyContent String!

TransactionContentInput

Field Type Description
templateId String

Not currently supported
contentBodies [TransactionContentBodyInput!]!

TransactionContentSettingsInput

Field Type Description
autoGenerateText Boolean!
autoGenerateHtml Boolean!

TransactionDomainAnalyticsInput

Field Type Description
domain String!

65 character limit
parameters [NameValueInput!]

Name: 50 character limit Value: 50 character limit

TransactionFromInput

Field Type Description
name String

255 character limit
emailAddress String!

320 character limit

TransactionHeaderInput

Field Type Description
subject String!

500 character limit
from TransactionFromInput!
replyTo TransactionReplyToInput
customHeaders [NameValueInput!]

TransactionRecipientInput

Field Type Description
name String

255 character limit
emailAddress String!

320 character limit
type RecipientType
metadata [NameValueInput!]

Name: 50 character limit Value: 255 character limit
variables [NameValueInput!]

TransactionReplyToInput

Field Type Description
name String

255 character limit
emailAddress String!

320 character limit

TransactionSandboxInput

Field Type Description
enable Boolean!
errorType SandboxErrorType!

TransactionSettingsInput

Field Type Description
sendAtUtc DateTime
tracking TransactionTrackingInput
sendRepliesTo String

320 character limit
sendBccTo String

320 character limit
showRecipients Boolean
ignoreSuppressCheck Boolean!
sandbox TransactionSandboxInput
content TransactionContentSettingsInput
enableViewOnline Boolean
analytics TransactionAnalyticsInput

TransactionTrackingInput

Field Type Description
opens Boolean!
clicks Boolean!
stripQueryString Boolean!
replies Boolean!

UpdateAccountGroupInput

Field Type Description
id String!
name String

100 character limit
description String

255 character limit
permissionKeys [String!]
lists [Long!]

UpdateAccountInput

Field Type Description
ownerId String
name String

255 character limit
streetAddressLine1 String

100 character limit
streetAddressLine2 String

50 character limit
city String

100 character limit
state_Province String

100 character limit
zip_PostalCode String

15 character limit
country_Region String

100 character limit
phone String

25 character limit
website String

255 character limit
defaultLanguage String

Must be a valid culture code or set to "Auto".
defaultTimezone String

Must be a valid IANA timezone or set to "Auto".

UpdateAccountStatusInput

Field Type Description
status AccountStatus!
reason String

255 character limit
exportAccountData Boolean
customerSupportRating Int

Number between 1 and 5
feedback String

500 character limit
paymentMethodId String

UpdateArticleContentInput

Field Type Description
mimeType MimeType!
content String!

UpdateArticleInput

Field Type Description
id String!
folderId String
name String

100 character limit
title String

100 character limit
language String

Must be a valid culture code or set to "Auto".
defaultLayout ArticleDefaultLayout
category String

50 character limit
description String

255 character limit
tags [String!]
contentBodies [UpdateArticleContentInput!]

UpdateBillingAddressInput

Field Type Description
firstName String!

100 character limit
lastName String!

100 character limit
emailAddr String!

320 character limit
streetAddressLine1 String!

100 character limit
streetAddressLine2 String

50 character limit
city String!

100 character limit
state_Province String!

100 character limit
zip_PostalCode String!

15 character limit
country_Region String!

100 character limit
phone String!

25 character limit

UpdateCampaignViewInput

Field Type Description
id String!
name String
tags [String!]
statuses [CampaignSendStatus!]
sendStartUtc DateTime
sendEndUtc DateTime
modifiedStartUtc DateTime
modifiedEndUtc DateTime
createdStartUtc DateTime
createdEndUtc DateTime
groupBy CampaignFields
sortBy CampaignFields
isPrivate Boolean

UpdateCreditCardInfoInput

Field Type Description
expirationMonth Int!

1-12
expirationYear Int!

yyyy format (ex: 2021)

UpdateDataFieldInput

Field Type Description
id String!
dataType DataType!
fieldName String!

50 character limit
dscr String

200 character limit
required Boolean!
isPublic Boolean!
mergeTag String

50 character limit
defaultValue String!

255 character limit
possibleValues [UpdateDataFieldValueInput!]!
valueType FieldValueType!
minNbr Decimal
maxNbr Decimal
minDate DateTime
maxDate DateTime
allowOther Boolean!
monthDayFormat Boolean!
subscriberListId String!

UpdateDataFieldValueInput

Field Type Description
label String!

100 character limit
value String!

100 character limit
displayOrder Int!

UpdateDoubleOptInContentInput

Field Type Description
email UpdateDoubleOptInEmailInput
pageHtml String

UpdateDoubleOptInEmailInput

Field Type Description
fromName String!
fromEmail String!
subject String!
replyTo String!

UpdateFileInput

Field Type Description
id String!
name String
folderId String
tags [String!]

UpdateFileViewInput

Field Type Description
id String!
name String
tags [String!]
types [FileType!]
modifiedStartUtc DateTime
modifiedEndUtc DateTime
createdStartUtc DateTime
createdEndUtc DateTime
groupBy FileFields
sortBy FileFields
isPrivate Boolean

UpdateFolderInput

Field Type Description
id String!
name String
parentId String

UpdateGroupInput

Field Type Description
id String!
name String!

100 character limit
description String

255 character limit
isPublic Boolean!
isDynamic Boolean!
sourceGroupIds [String!]!

Use to combine groups previously created
criteria ConditionGroupInput
subscriberListId String!

UpdateGroupSubscriberInput

Field Type Description
groupId String!
groupName String!

UpdatePaymentMethodInput

Field Type Description
id String!
nickname String

100 character limit
isDefault Boolean
creditCardInfo UpdateCreditCardInfoInput
billingAddress UpdateBillingAddressInput

UpdateProfileFieldInput

Field Type Description
dataFieldId String!
labelText String!

UpdateQuestionCategoryInput

Field Type Description
text String!
answers [String!]!

UpdateQuestionInput

Field Type Description
id String!
type QuestionType!
text String!
dataFieldId String
required Boolean!
display Boolean!
displayOrder Int!
categories [UpdateQuestionCategoryInput!]!
answers [String!]

UpdateSubscriberInput

Field Type Description
id String!
subscriberIp String

Needs to be in valid Ip format (000.000.000.000)
longitude Decimal
latitude Decimal
city String

100 character limit
state_Province String

100 character limit
zip_PostalCode String

15 character limit
country_Region String

100 character limit
timeZone String!
cultureCode String!
email String!

100 character limit
sendFormat SendFormat!
optInDateTimeUtc DateTime
optInIp String!
optOutDateTimeUtc DateTime
optOutSource OptOutSource!
optOutIp String!
optOutReason String!
subscriberListId String!
groups [UpdateGroupSubscriberInput!]!
profile [UpdateProfileFieldInput!]!
tags [String!]!

UpdateSubscriberListFormDialogInput

Field Type Description
type FormDialogType!
message String
thankYouIcon FormDialogIcon
iconColor String
displayRedirectButton Boolean
redirectButtonText String
redirectButtonUrl String
redirectButtonColor String
showRedirectButton Boolean
buttonText String
redirectUrl String
displayCloseButton Boolean
displayResults Boolean
displayAnswers Boolean

UpdateSubscriberListFormInput

Field Type Description
id String!
name String
pageName String
pageTitle String
metaDescription String
metaKeywords [String!]
socialStoryImageUrl String
defaultLanguage String
translationLanguages [String!]
requiredTextTranslation String
formErrorTextTranslation String
redirectUrl String
submitAction FormAction
sendThankYou Boolean
groups [GroupInput!]
tags [String!]
sendNotificationEmail Boolean
attachmentFormat FormAttachmentFormat
duplicateEmailAction FormDuplicateEmailAction
duplicateEmailErrorAction FormAction
duplicateEmailErrorRedirectUrl String

UpdateSubscriberListFormPageInput

Field Type Description
type FormPageType!
content String!

UpdateSubscriberListInput

Field Type Description
id String!
name String

100 character limit
tags [String!]

50 character limit
companyName String

255 character limit
streetAddressLine1 String

100 character limit
streetAddressLine2 String

50 character limit
city String

100 character limit
state_Province String

100 character limit
zip_PostalCode String

15 character limit
country_Region String

100 character limit
phone String

25 character limit
defaultFromName String

50 character limit
defaultFromEmail String

320 character limit
requireDoubleOptIn Boolean

UpdateSubscriberListViewInput

Field Type Description
id String!
name String
tags [String!]
minOpenRate Float
maxOpenRate Float
minClickRate Float
maxClickRate Float
groupBy String
sortBy String
isPrivate Boolean

UpdateTemplateContentInput

Field Type Description
mimeType MimeType!
content String!

UpdateTemplateInput

Field Type Description
id String!
name String

100 character limit
contentBodies [UpdateTemplateContentInput!]
tags [String!]

UpdateTemplateViewInput

Field Type Description
id String!
name String
tags [String!]
types [TemplateType!]
modifiedStartUtc DateTime
modifiedEndUtc DateTime
createdStartUtc DateTime
createdEndUtc DateTime
groupBy TemplateFields
sortBy TemplateFields
isPrivate Boolean

UpdateUserInput

Field Type Description
id String!
firstName String!

100 character limit
lastName String

100 character limit
phoneNumber String

25 character limit
language String

Must be a valid culture code or set to "Auto".
isActive Boolean
timezone String

Must be a valid IANA timezone or set to "Auto".
theme AppTheme

VerifySenderDomainInput

Field Type Description
dkimSelector String!

255 character limit
domain String!

65 character limit

Enums

AccountStatus

SUSPEND status can only be set by a system user

Value Description
ACTIVE
RELAX
HIBERNATE
_SUSPEND
DELETE

AppTheme

Value Description
LIGHT
DARK

ApplyPolicy

Value Description
BEFORE_RESOLVER
AFTER_RESOLVER

ArticleDefaultLayout

Value Description
PTL_TTR_CBR
PTR_TTL_CBL
PTC_TCC_CBC
PBC_TTC_CCC
PNA_TTL_CBL
PTL_TNA_CTR

CampaignFields

Value Description
NAME
SEND_DATE

CampaignSendStatus

Value Description
NOT_SCHEDULED
PENDING
QUEUED
PROCESSING
PAUSED
STOPPED
SENT_PENDING_AB_WINNER
COMPLETED
SYSTEM_STOPPED

CardDeclineReason

Value Description
NO_REASON
INSUFFICIENT_FUNDS
EXPIRED

Charset

Value Description
UTF8

ConditionGroupOperator

Value Description
AND
OR

CreditCardNetwork

Value Description
VISA
MASTERCARD
AMERICAN_EXPRESS
DISCOVER
INTER_LINK
STAR
ACCEL
INTERAC
VISA_READY_LINK
PULSE
JCB
DINERS_CLUB
UNKNOWN

DataType

Value Description
TEXT
DATE
DATE_TIME
NUMBER
BIRTHDAY
ZIP_CODE
PHONE
INT_PHONE
IMAGE
URL
ADDRESS
STATE
COUNTRY
EMAIL

EmailEventType

Value Description
DELIVERED
OPEN
CLICK
FEEDBACK
RATING
CREATED
PROCESSED
VIEW_ONLINE
SOCIAL_SHARE
FORWARD
FORWARD_TO_FRIEND
VIEW_PROFILE
VIEW_ARCHIVE
PRINT
COMPLAINT
UNSUBSCRIBED
HARD
SOFT
SOFT_SENDER_AUTH
SOFT_IP
SOFT_DNS
BLOCK
BLOCK_CONTENT
BLOCK_SENDER
DECLINED
INVALID_EMAIL
SUPPRESSED

EventSourceType

Value Description
CAMPAIGN
TRANSACTION

ExportStatus

Value Description
ANY
PENDING
PROCESSING
COMPLETED
FAILED

FieldValueType

Value Description
ANY_VALUE
ONE_OF_MANY
MANY_OF_MANY

FileDelimiter

Value Description
TAB
COMMA
SEMICOLON
PIPE

FileFields

Value Description
NAME
SIZE
IS_PUBLISHED
PUBLISHED_UTC
CATEGORY

FileType

Value Description
UNKNOWN
IMAGE
FILE
ARTICLE
CONTENT_BLOCK

FormAction

Value Description
DISPLAY_MESSAGE
REDIRECT_TO_PAGE
REDIRECT_TO_URL

FormAttachmentFormat

Value Description
NO_ATTACHMENT
JSON
CSV

FormDialogIcon

Value Description
CLIPBOARD
CIRCLE_CHECK_MARK
THUMBS_UP
CHECK_MARK

FormDialogType

Value Description
SUBMIT
DUPLICATE_EMAIL

FormDuplicateEmailAction

Value Description
IGNORE
UPDATE_SUBSCRIBER
SHOW_ERROR

FormEventType

Value Description
VIEW
ABANDON
SUBMIT
PARTIAL_SUBMIT
SHARE_EMAIL
SHARE_SOCIAL

FormExportStyle

Value Description
BASIC
STANDARD

FormPageType

Value Description
SUBMIT
DUPLICATE_EMAIL

FormType

Value Description
SIGN_UP

ImportDeleteArea

Value Description
NONE
SUBSCRIBER_LIST
SELECTED_GROUPS

ImportStatus

Value Description
ANY
PENDING
PROCESSING
COMPLETED
FAILED

InviteStatus

Value Description
PENDING
ACCEPTED
EXPIRED

InvoiceStatus

Value Description
PAID
PENDING
PAYMENT_FAILED

MimeType

Value Description
HTML
TEXT
AMP
MARKDOWN

Operator

Value Description
EQUAL
NOT_EQUAL
GREATER_THAN
GREATER_THAN_EQUAL_TO
LESS_THAN
LESS_THAN_EQUAL_TO
STARTS_WITH
NOT_START_WITH
CONTAIN
NOT_CONTAIN
IS_BLANK
NOT_BLANK
MONTH_IS
DAY_IS
OPENED
NOT_OPENED
CLICKED
NOT_CLICKED
SENT
NOT_SENT
REPLIED
NOT_REPLIED
STARTED
NOT_STARTED
COMPLETED
NOT_COMPLETED

OptInSource

Value Description
FILE_IMPORT
URL
MANUAL
EMAIL_LINK
PROFILE_UPDATE
API

OptOutSource

Value Description
NONE
FILE_IMPORT
URL
MANUAL
EMAIL_LINK
PROFILE_UPDATE
API

PaymentStatus

Value Description
APPROVED
DECLINED
ERROR
HELD_FOR_REVIEW

QuestionType

Value Description
SHORT_TEXT
LONG_TEXT
DROPDOWN
CHECKBOX
RADIO
HTML_BLOCK
MATRIX_CHECKBOX
MATRIX_RADIO
GROUPS
HIDDEN

RawDataType

Value Description
STRING
NUMBER
DATE_TIME

RecipientType

Value Description
TO
CC
BCC

ResourceType

Value Description
TEMPLATE

SandboxErrorType

Value Description
NONE
ERROR
INVALID_EMAIL

SendFormat

Value Description
ANY
HTML
TEXT

ServiceType

Value Description
NOT_DEFINED
EMAIL_MARKETING
EMAIL_MARKETING_PREPAY
TRANSACTION
TRANSACTION_PREPAY
SMS
SMS_PREPAY
FILE_STORAGE
ADDITIONAL_IP
PROFESSIONAL_SERVICES
ADDITIONAL_SERVICES
EMAIL_MARKETING_DISCOUNT
EMAIL_MARKETING_PRE_PAY_DISCOUNT
TRANSACTION_DISCOUNT
TRANSACTION_PRE_PAY_DISCOUNT
FEE

Status

Value Description
ACTIVE
INACTIVE
DELETED

SubscriberListMessageType

Value Description
OPT_IN_CONFIRMATION
OPT_IN_NOTIFICATION
OPT_IN_WELCOME
OPT_OUT_CONFIRM
OUT_OUT_NOTIFICATION
PROFILE_UPDATE_CONFIRM
PROFILE_UPDATE_NOTIFICATION
FORWARD_TO_FRIEND
FORWARD_TO_FRIEND_NOTIFICATION
CONVERSATION_RESPONSE

SubscriberStatus

Value Description
ANY
ACTIVE
UNDELIVERABLE
OPT_OUT
PENDING_CONFIRM
SPAM
CLEANED

TemplateCategory

Value Description
LAYOUT
TEMPLATE
CUSTOM_TEMPLATE
CODE_YOUR_OWN
PREVIOUS_CAMPAIGNS
START_FROM_SCRATCH

TemplateFields

Value Description
NAME
DESCRIPTION
TYPE
CATEGORY
CREATED_UTC
MODIFIED_UTC

TemplateSubCategory

Value Description
NONE
NEWS_LETTER
ECOMMERCE

TemplateType

Value Description
STANDARD
CUSTOM

UserStatus

Value Description
ACTIVE
SUSPENDED
DELETED
INACTIVE

Scalars

Boolean

The Boolean scalar type represents true or false.

Byte

The Byte scalar type represents non-fractional whole numeric values. Byte can represent values between 0 and 255.

DateTime

The DateTime scalar represents an ISO-8601 compliant date time type.

Decimal

The built-in Decimal scalar type.

Float

The Float scalar type represents signed double-precision fractional values as specified by IEEE 754.

Int

The Int scalar type represents non-fractional signed whole numeric values. Int can represent values between -(2^31) and 2^31 - 1.

Long

The Long scalar type represents non-fractional signed whole 64-bit numeric values. Long can represent values between -(2^63) and 2^63 - 1.

String

The String scalar type represents textual data, represented as UTF-8 character sequences. The String type is most often used by GraphQL to represent free-form human-readable text.