Skip to main content
objectMarketingBanner

Implements

Fields

appLinkUrl
String

Native-app deep link to the targeted Payment Plan, for the mobile clients. Null unless the Banner targets a Payment Plan.

buttonText
String

Label of the call-to-action button.

buttonUrl
String

URL the call-to-action button links to.

createdAt
ISO8601DateTime

When the Banner was created.

creator

The Host who created the Banner.

descriptionHtml
String

The Banner's body as sanitized HTML.

endsAt
ISO8601DateTime

When the Banner stops showing. Null when it never expires.

id
ID!

ID of the object.

isActive
Boolean

Whether the Host has turned the Banner on.

marketingAudience

The Marketing Audience the Banner is targeted at.

name
String

The Banner's internal name, shown only to Hosts.

permanentlyDismissible
Boolean!

Whether a member can permanently dismiss the Banner.

resourceId
ID!

Resource ID for this object, for interop with the Admin API.

startsAt
ISO8601DateTime

When the Banner starts showing. Null when it starts immediately.

Lifecycle status of the Banner.

The platforms the Banner is shown on.

The entity the Banner links to (a Payment Plan). Null when the Banner uses a custom button URL instead.

title
String!

The Banner's headline shown to members.