Skip to main content
inputCreateMarketingBannerInput

Fields

buttonText
String

Label of the call-to-action button.

buttonUrl
String

URL the call-to-action button links to. Must be https. Cannot be combined with a targetable.

clientMutationId
String

A unique identifier for the client performing the mutation.

description
String

The Banner's body. HTML is sanitized server-side.

endsAt
ISO8601DateTime

When the Banner stops showing. Omit for a Banner that never expires.

marketingAudienceId
ID!
required

The active Marketing Audience to target — resource ID or GlobalID.

name
String!
required

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

permanentlyDismissible
Boolean

Whether a member can permanently dismiss the Banner.

startsAt
ISO8601DateTime

When the Banner starts showing. Defaults to immediately.

The platforms the Banner is shown on. Defaults to every platform.

targetableId
ID

The entity the Banner targets — a Payment Plan resource ID or GlobalID. Provide together with targetableType.

The kind of entity the Banner targets. Provide together with targetableId; cannot be combined with buttonUrl.

title
String!
required

The Banner's headline shown to members.