Setup

Setup

Sending setup status, domains + DNS, senders, webhooks, project settings, and the kill switch. Connecting a provider and minting API keys happen in the app.

email_get_connection_status

READ — Sending-setup status for the scoped company: provider connection (masked key), domains with per-record DNS state, senders, webhook registration, kill switch, and `settingsUrl` — the sending settings page where the operator connects a provider or the platform they are migrating off, adds domains and senders, and mints API keys.

email_create_domain

WRITE — Register a sending domain with the provider (use a SUBDOMAIN like mail.example.com, never the root).

email_verify_domain

WRITE — Trigger provider verification for a sending domain and return per-record status plus a DMARC advisory (DMARC never blocks verification).

email_delete_domain

WRITE — Delete a sending domain: removes it from the project (its senders go with it) AND from the provider account unless another project still uses it.

email_register_webhooks

WRITE — Point the provider's delivery/bounce/complaint/open/click events at our webhook endpoint so metrics and auto-suppression work.

email_create_sender

WRITE — Create a sender identity (from name + address) on a VERIFIED sending domain.

email_list_senders

READ — List the company's sender identities.

email_update_sender

WRITE — Update an existing sender's display name and/or reply-to address.

email_delete_sender

WRITE — Delete a sender identity.

email_set_default_sender

WRITE — Make a sender the project default (used when a template has no sender).

email_send_test_email

WRITE — Prove the plumbing end to end: send a minimal test email (no template) from the default sender to the given address.

email_set_sends_paused

WRITE — Kill switch: pause or resume ALL sending for this company (API, automations, copilot).

email_set_daily_send_cap

WRITE — Set an OPTIONAL daily send cap that tightens below the provider plan's own daily limit (emails/day across ALL sources — API, automations, copilot).

email_set_default_locale

WRITE — Set the project's default locale — the fallback used to pick a template translation when neither the send call nor the contact's `locale` attribute carries one.

email_set_utm_tagging

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

email_get_queue_health

READ — Background-job queue health for the whole workspace: pending jobs due now, age of the oldest pending job, in-flight count, and dead-letter count.

email_get_onboarding_steps

READ — The guided setup's ten steps for the scoped company, each with its address (1.1–3.5), title, phase and whether it is done — the same list the operator sees in the dashboard.

email_get_project_settings

READ — Read the sending guardrails: kill switch (sendsPaused), daily send cap, UTM tagging, default locale, and how many emails went out today — read this before changing any of them.