Skip to main content
inputUpdateMarketingBannerInput

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.

When the Banner stops showing. Pass null to clear the end date.

expectedLastEditedAt

The Banner's last edit stamp as the caller last read it. When someone else has changed the Banner's content since, the update is refused with a CONFLICT error. Omit to update whatever the Banner holds.

id
ID!
required

Marketing Banner ID — resource ID or GlobalID.

isActive
Boolean

Whether the Host has turned the Banner on. Activating is rejected when the Network is at its active-Banner limit.

marketingAudienceId
ID

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

name
String

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

permanentlyDismissible
Boolean

Whether a member can permanently dismiss the Banner.

When the Banner starts showing.

The platforms the Banner is shown on.

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

The Banner's headline shown to members.