Promotional API Mutations

Available to: Publishers only. Advertisers have read-only access to this API and cannot create or update promotional properties. See the Queries page for read operations available to both user types.

Mutation: `createPromotionalProperty`

Returns: PromotionalProperty!

Adds a new promotional property to your publisher program.

Argument	Type	Description
`input`	`CreatePromotionalPropertyInput`	The details of the promotional property to create. See `CreatePromotionalPropertyInput` below.

Mutation: `updatePromotionalProperty`

Returns: PromotionalProperty!

Updates an existing promotional property within your publisher program.

Argument	Type	Description
`input`	`UpdatePromotionalPropertyInput`	The updated details for the promotional property. See `UpdatePromotionalPropertyInput` below.

Input Objects

CreatePromotionalPropertyInput

Used to add a new promotional property to your publisher program.

Field	Type	Description
`name`	`String!`	The name for the promotional property.
`description`	`String`	An advertiser-facing description of the promotional property. Optional.
`publisherId`	`ID!`	The publisher CID.
`propertyTypeDetails`	`PromotionalPropertyTypeDetailsInput!`	Details specific to the property's type (e.g. website URL, social handle). See `PromotionalPropertyTypeDetailsInput` below.
`promotionalModels`	`[PromotionalModelInput!]!`	The promotional models for this property. At least one must be marked as primary.
`tags`	`[PromotionalPropertyTagInput!]!`	Publisher-supplied tags describing the property. Used as keywords or categories; searchable and visible to advertisers.
`status`	`PromotionalPropertyStatus!`	The status of the promotional property.
`isPrimary`	`Boolean!`	Indicates if this is the primary property for the publisher account. Used primarily for reporting.

UpdatePromotionalPropertyInput

Used to update an existing promotional property within your publisher program.

Field	Type	Description
`id`	`ID!`	The promotional property ID to update.
`name`	`String!`	The updated name for the promotional property.
`description`	`String`	An updated advertiser-facing description. Optional.
`publisherId`	`ID!`	The publisher CID.
`propertyTypeDetails`	`PromotionalPropertyTypeDetailsInput!`	Updated type-specific details. See `PromotionalPropertyTypeDetailsInput` below.
`promotionalModels`	`[PromotionalModelInput!]!`	Updated promotional models. At least one must be marked as primary.
`tags`	`[PromotionalPropertyTagInput!]!`	Updated tags for the property.
`status`	`PromotionalPropertyStatus!`	Updated status of the promotional property.
`isPrimary`	`Boolean!`	Indicates if this is the primary property for the publisher account.

PromotionalPropertyTypeDetailsInput

Defines the type-specific details of a promotional property. The type field is always required; all other fields are conditional on the type selected.

Field	Type	Applicable Type(s)	Description
`type`	`PromotionalPropertyType!`	All	Required. The property type.
`websiteUrl`	`String`	`WEBSITE`	The URL for the website.
`browserExtensionName`	`String`	`BROWSER_EXTENSION`	The name of the browser extension as it appears in the download store.
`browserExtensionDescription`	`String`	`BROWSER_EXTENSION`	Description of how the extension functions and how customers engage with it.
`browserExtensionDownloadInformation`	`[BrowserExtensionDownloadInformationInput!]`	`BROWSER_EXTENSION`	Download links and supported browsers.
`browserExtensionTrackingConsentType`	`TrackingConsentType`	`BROWSER_EXTENSION`	Whether the extension operates on affirmative click only or automatic redirect.
`browserExtensionTrackingDescription`	`String`	`BROWSER_EXTENSION`	Additional description of the extension's tracking behavior.
`mobileAppName`	`String`	`MOBILE_APP`	The app name as it appears in the app store.
`mobileAppDownloadInformation`	`[MobileAppDownloadInformationInput!]`	`MOBILE_APP`	Download links and supported platforms.
`servicesAndToolsMarketingSiteUrl`	`String`	`SERVICES_AND_TOOLS`	Marketing site URL for services and tools properties.
`emailAddress`	`String`	`EMAIL`	The send-from email address for the newsletter campaign.
`emailMailingListSize`	`Int`	`EMAIL`	The size of the mailing list.
`emailOpenRate`	`Float`	`EMAIL`	The approximate open rate for email newsletters.
`socialMediaPlatform`	`SocialPlatform`	`SOCIAL_MEDIA`	The social media platform. See `SocialPlatform` enum.
`socialMediaHandle`	`String`	`SOCIAL_MEDIA`	The account link or handle.
`paidDisplayAdsDescription`	`String`	`PAID_DISPLAY_ADS`	Platforms where display ads are purchased and the click-through rates achieved.
`paidSearchEngineDescription`	`String`	`PAID_SEARCH_ENGINE`	Platforms where search ads are purchased and the click-through rates achieved.
`otherDescription`	`String`	`OTHER`	A text description of the property type.

PromotionalModelInput

Field	Type	Description
`type`	`PromotionalModelType!`	The promotional model type. See `PromotionalModelType` enum.
`isPrimary`	`Boolean!`	Indicates if this is the primary promotional model for the property.
`description`	`String`	Text description of the model. Only supported for `OTHER` type promotional models.

PromotionalPropertyTagInput

Field	Type	Description
`name`	`String!`	The tag value. Tags can be keywords, categories, or any descriptors for the property — they are searchable and visible to advertisers.

BrowserExtensionDownloadInformationInput

Field	Type	Description
`browserExtensionBrowser`	`BrowserType`	The browser type for this download entry. See `BrowserType` enum.
`browserExtensionDownloadLink`	`String`	The URL where end users can download the extension for this browser.

MobileAppDownloadInformationInput

Field	Type	Description
`mobileAppDownloadLink`	`String`	The URL where end users can download the app for this platform.
`mobileAppPlatform`	`MobileAppPlatform`	The mobile app platform. See `MobileAppPlatform` enum.

Mutation: createPromotionalProperty

Mutation: updatePromotionalProperty