About the Marketing Settings API

The Marketing Settings API configures the preferences that shape how the AI generates a site's marketing plan and posts. Settings include the marketing goal, the social channels to post to, the point of view and tone of voice, the content frequency per marketing tool, and the content pillars (the topics to focus on or avoid). The site's language and location (businessLocation) are read-only here and derived from the site itself; targetLocations is deprecated in favor of businessLocation.

With the Marketing Settings API, you can:

• Retrieve a site's marketing settings.
• Create or update settings in a single upsert call.
• Retrieve the selectable options and defaults for settings, such as the available goals and points of view.

Before you begin

It's important to note the following points before starting to code:

• Settings are optional. If a site hasn't saved any settings, GetMarketingSettings returns only the derived language, targetLocations, and businessLocation; all preference fields are empty. Defaults are applied automatically at generation time. To inspect those defaults before generating, call GetMarketingSettingsDefaults.
• To customize the generated plan and posts, upsert the settings before generating.
• For social posts to be generated, social marketing must be among the site's enabled marketing tools.
• The site's language and location are derived from the site and can't be changed through this API. Set them in the site's own settings.
• Changing settings doesn't update an existing plan. After changing settings, call Regenerate Marketing Plan for the change to take effect. After changing the content pillars (topics), use Regenerate Marketing Plan with Keyword Research instead.

Use cases

• Tailor the plan with marketing settings

Terminology

• Marketing settings: A site's preferences that shape how the AI generates its marketing plan and posts.
• Marketing goal: The primary objective the plan optimizes for, such as driving traffic or growing an audience.
• Point of view: The narrative perspective the AI writes posts from.
• Content pillars: The recurring themes or topics the plan's content is built around.

See also

• Marketing Plan API: Sample Flows