Magidoc

Audience
Object

A subscriber list (audience) containing contacts, groups, and campaign settings

Fields

#

addressCountry

String

Country for physical mailing address

addressLocality

String

City or locality for physical mailing address

addressRegion

String

State, province, or region for physical mailing address

companyName

String

Company name displayed in campaign footers and headers

createdBy

String !
Non-null

User who created the subscriber list

createdUtc

DateTime !
Non-null

UTC timestamp when the subscriber list was created

dateFormat

String

Date format used for displaying dates

dateTimeFormat

String

Date/time format used for displaying timestamps

daysSinceLastCampaign

Short

Number of days since the last campaign was sent to this list

defaultFromEmail

String

Default sender email address for campaigns

defaultFromText

String

Default sender name displayed in email clients

deliverabilityHealthScore

Byte

Deliverability health score (0-100) based on sending consistency and recency

deliverabilityRiskLevel

DeliverabilityRiskLevel

Deliverability risk level: 0=Healthy, 1=Warning, 2=Critical, 3=Crisis

doubleOptInConfirmAction

SubmitActionType !
Non-null

Action to take after successful double opt-in confirmation

doubleOptInConfirmExternalUrl

String

External URL to redirect to after double opt-in confirmation

doubleOptInConfirmPageJson

String

JSON configuration for double opt-in confirmation page

doubleOptInContentHtml

String

HTML content for double opt-in confirmation emails

doubleOptInFromEmail

String

Sender email address for double opt-in confirmation emails

doubleOptInFromName

String

Sender name for double opt-in confirmation emails

doubleOptInSubject

String

Subject line for double opt-in confirmation emails

gdprDescription

String

Description text for GDPR consent requirements

gdprLegalTerms

String

Legal terms and conditions for GDPR compliance

gdprTitle

String

Title for GDPR consent statement

hasWebhook

Boolean !
Non-null

Indicates if an inbound webhook is configured for this list

id

String !
Non-null

Unique identifier for the subscriber list

keyFields

[String !]!
Non-null

List of data field names that comprise the unique key for subscribers

lastModifiedUtc

DateTime !
Non-null

UTC timestamp when the subscriber list was last modified

modifiedBy

String !
Non-null

User who last modified the subscriber list

name

String !
Non-null

Display name of the subscriber list

numberFormat

String

Number format used for displaying numeric values

phone

String

Contact phone number displayed in campaigns

postalCode

String

Postal or ZIP code for physical mailing address

requireDoubleOptIn

Boolean !
Non-null

Requires new subscribers to confirm their subscription via email

sendCadenceLastCalculatedUtc

DateTime

UTC timestamp of last send cadence calculation

sendCadenceMultiplier

Decimal !
Non-null

Multiplier adjusting engagement time windows based on sending frequency (1.0=weekly, 2.0=bi-weekly, 4.0=monthly)

sendCadenceTier

SendCadenceTier !
Non-null

Send cadence tier: 1=Weekly+, 2=Bi-weekly, 3=Monthly, 4=Quarterly+

streetAddress

String

Street address displayed in campaign footers (CAN-SPAM requirement)

streetAddress2

String

Secondary address line (suite, apartment, unit number)

tags

[String !]

Tags applied to this subscriber list

totalActiveContacts

Int !
Non-null

Number of active, confirmed subscribers eligible to receive campaigns

totalComplaintContacts

Int !
Non-null

Number of subscribers who marked emails as spam

totalContacts

Int !
Non-null

Total number of subscribers across all statuses

totalSuppressedContacts

Int !
Non-null

Number of subscribers manually removed or suppressed

totalUnconfirmedContacts

Int !
Non-null

Number of subscribers awaiting double opt-in confirmation

totalUndeliverableContacts

Int !
Non-null

Number of subscribers with hard bounces or delivery failures

totalUnsubscribedContacts

Int !
Non-null

Number of subscribers who have unsubscribed

website

String

Website URL displayed in campaigns

Usages

#

References

#

  • Field createAudienceSecurityRole from Mutation