Skip to main content
inputCreatePaymentPlanAnnouncementInput

Fields

body
String!
required

The announcement message. Simple HTML is sanitized server-side.

clientMutationId
String

A unique identifier for the client performing the mutation.

externalLink
String

Optional URL to attach to the announcement. Only available on Networks with external announcement links enabled; supplying one otherwise is rejected.

paymentPlanId
ID!
required

Payment Plan whose buyers to notify — resource ID or GlobalID.

recipientIds
[ID!]

Resource IDs or GlobalIDs of specific buyers to notify. Every entry must be a buyer of the plan. Omit to notify every buyer; an empty list is rejected.

subject
String

Short notification text shown to recipients, truncated to 150 characters. Defaults to a greeting attributed to the sending Host when omitted.