Setup

email_set_utm_tagging

Configure auto UTM tagging: params appended to every external link in outgoing emails (Google Ads-style, set once and forget).

write email_set_utm_tagging

Configure auto UTM tagging: params appended to every external link in outgoing emails (Google Ads-style, set once and forget). Tagging is ALREADY ON by default (utm_source=email, utm_medium=email, utm_campaign={{automation}}, utm_content={{template}}-{{step}}, utm_term={{variant}}) — call this only to change those params or to switch tagging off. Values may embed {{automation}}, {{step}}, {{template}}, {{variant}}, {{source}} — resolved per send, slugified, omitted when empty; existing URL params always win. Pass enabled=false to turn tagging off. Read the current config from email_get_connection_status.

Parameters

ParameterTypeRequiredDescription
enabledbooleanYes
paramsobjectNoParam name → value template. Max 10, lowercase snake_case keys.
confirmbooleanYesMust be true — confirms the human explicitly decided this.
projectIdstringNoTarget company (project id) — required on project-scoped tools. Call email_list_projects to enumerate companies.

On this page