start_date | string (ISO-8601) | 7 days ago | Earliest commit timestamp to include. |
end_date | string (ISO-8601) | now | Latest commit timestamp to include. |
product_name | string | project name | Override the product name used in the banner. |
idea | object | — | Optional {title, summary} suggestion to focus the banner on; commits unrelated to the idea are ignored. |
link_url | string (http/https) | resolved at publish | Where the call-to-action points. Omit to fall back to the project’s configured Changelog page (Destinations → Website), then the period’s published changelog permalink; with neither, the banner renders without a link. |
expires_after_days | 7 | 14 | 30 | — | Stop serving the banner this many days after publication. Omit to keep it live until the next banner replaces it. |
badge | string (≤ 16 chars) | project default | The short tag shown before the headline (e.g. "Beta", "v2.0"). Omit to use the project’s default badge (Destinations → Website), which is "New" unless changed. |
show_badge | boolean | true | Pass false to render the banner without a badge, whatever the project default. |
audience | "technical" | "business" | "mixed" | project default | Technical depth of the writing. Omit to use the project’s content guidelines default. |
instructions | string (≤ 2000 chars) | project default | Free-text guidance on scope, tone, or terminology. Omit to use the project default. |
repos | string[] | all tracked repos | Restrict the commit source to these tracked repositories (full names, e.g. ["acme/backend"]), as listed by get_project_context. |