# Nitrosend

> The AI-native email marketing platform — manage your email from Claude, GPT, Gemini, Codex, or any AI tool

## Documentation

- [Introduction](/introduction): The AI-native email marketing platform — manage your email from Claude, GPT, Gemini, Codex, or any AI tool
- [Quickstart](/quickstart): Send your first email in under 5 minutes — connect your AI tool via MCP and start prompting
- [Authentication](/authentication): How to authenticate with the Nitrosend API
- [Connect Your AI Tool](/integrations/overview): Connect Nitrosend to Claude, GPT, Gemini, Codex, or any AI assistant via MCP or REST API
- [Claude Desktop](/integrations/claude-desktop): Add Nitrosend as a Custom Connector in Claude Desktop for conversational email marketing
- [Claude Cowork](/integrations/claude-cowork): Connect Nitrosend to Claude Cowork for team-based AI email marketing
- [Claude Code](/integrations/claude-code): Connect Nitrosend to Claude Code via MCP for terminal-based AI email marketing
- [Cursor](/integrations/cursor): Connect Nitrosend to Cursor via MCP for AI-powered email marketing inside your editor
- [ChatGPT / GPT](/integrations/chatgpt): Connect Nitrosend to ChatGPT through the ChatGPT app marketplace
- [OpenAI Codex CLI](/integrations/codex): Give Codex CLI access to Nitrosend via MCP for AI-powered email automation from your terminal
- [Google Gemini](/integrations/gemini): Connect Nitrosend to Gemini CLI via MCP for AI-powered email marketing
- [VS Code (Copilot)](/integrations/vscode): Connect Nitrosend to VS Code via MCP for AI-powered email marketing with GitHub Copilot
- [Windsurf](/integrations/windsurf): Connect Nitrosend to Windsurf via MCP for AI-powered email marketing with Cascade
- [Zed](/integrations/zed): Connect Nitrosend to Zed via MCP for AI-powered email marketing
- [Brand Settings & AI Memory](/integrations/mcp-brand-memory): Teach your AI your brand voice, goals, and strategy so every email it creates is on-brand
- [REST API](/integrations/rest-api): Use the Nitrosend REST API from any language, tool, or automation platform
- [Vercel AI SDK](/integrations/vercel-ai-sdk): Use Nitrosend tools inside Vercel AI SDK agents and generateText/streamText calls
- [Vercel Marketplace](/integrations/vercel-marketplace): Install Nitrosend from Vercel Marketplace and connect project-ready AI SDK and MCP secrets
- [Sending Emails](/guides/sending-emails): Design and send emails with Nitrosend
- [Managing Contacts](/guides/managing-contacts): Import, organize, and segment your audience
- [Building Flows](/guides/building-flows): Create automated workflows triggered by events
- [Creating Campaigns](/guides/creating-campaigns): Send bulk email campaigns to your audience
- [Contacts](/concepts/contacts): Understanding contacts in Nitrosend
- [Templates](/concepts/templates): Reusable email designs
- [Flows](/concepts/flows): Automated multi-step workflows
- [Campaigns](/concepts/campaigns): One-time email sends to your audience
- [Segments](/concepts/segments): Dynamic audience groups based on conditions

## MCP Tools

- [nitro](/mcp): Multi-channel marketing automation platform. Use nitro_get_status first for current account and brand context, readiness, blockers, warmup, and recommendations. OAuth connections can switch current brand with nitro_select_brand; API-key connections are pinned to their key's brand.
- [nitro_get_status](/mcp#operation-nitro-get-status-tool): tool — Get current account context, sender identity, dashboard links, readiness, onboarding status, and recommendations.
- [nitro_select_brand](/mcp#operation-nitro-select-brand-tool): tool — Select the current brand for this OAuth MCP connection. Use this instead of passing brand_sid to other tools. API-key connections are brand-pinned and cannot switch.
- [nitro_query](/mcp#operation-nitro-query-tool): tool — Query any Nitrosend entity. Returns paginated results.
- [nitro_search_contacts](/mcp#operation-nitro-search-contacts-tool): tool — Search contacts by email, name, or phone. Returns summary list or full profile.
- [nitro_set_brand](/mcp#operation-nitro-set-brand-tool): tool — Set up brand identity from website URL or direct fields. Provide url to auto-scrape brand colors/fonts, or fields to set values directly, or both (fields override scraped values). Sync mode (default) returns results immediately — best when you need brand data now for composing. Async mode (mode: 'async') runs scraping in the background — use when deferred completion is acceptable.
- [nitro_ingest_image](/mcp#operation-nitro-ingest-image-tool): tool — Ingest a local or chat-attached image into Nitrosend and return a Nitro CDN URL you can place directly into email design fields like image.src, product.image_url, hero.background_url, or theme.logo_url.
- [nitro_manage_audience](/mcp#operation-nitro-manage-audience-tool): tool — Create contacts, manage subscriptions, lists, events, segments, and tags.
- [nitro_define_segment](/mcp#operation-nitro-define-segment-tool): tool — Define a contact segment with explicit filters and preview. Defaults to preview_only: true (dry preview without saving). Set preview_only: false and provide a name to persist.
- [nitro_import_contacts](/mcp#operation-nitro-import-contacts-tool): tool — Import contacts from inline records (< 100) or reference a pre-uploaded CSV import. Email contacts are auto-subscribed by default. For SMS-only contacts, set opt_in: true explicitly (TCPA compliance).
- [nitro_manage_template](/mcp#operation-nitro-manage-template-tool): tool — Create, update, or clone a reusable email template. Brand theme applied automatically.
- [nitro_compose_flow](/mcp#operation-nitro-compose-flow-tool): tool — Create or replace an automation flow from trigger + steps array.
- [nitro_compose_campaign](/mcp#operation-nitro-compose-campaign-tool): tool — Compose and send an email or SMS to an audience. This is the default tool when users want to draft, write, or send an email.
- [nitro_manage_domains](/mcp#operation-nitro-manage-domains-tool): tool — Manage sending domains — add, verify, check DNS, list, and remove. Add returns the core DNS records needed to finish setup plus any optional improvements such as tracking or inbound routing. check_dns validates customer-facing records, Nitro-owned delegate targets, and tracking HTTPS readiness. Managed SES uses Nitro-branded MX indirection, while BYO providers return their own receiving records.
- [nitro_configure_account](/mcp#operation-nitro-configure-account-tool): tool — Read or configure sender defaults (from_name, from_email, reply_to) and test email recipients. Use nitro_get_status for account identity, dashboard links, readiness, and blockers. from_email must be authorized by a verified sending domain.
- [nitro_review_delivery](/mcp#operation-nitro-review-delivery-tool): tool — Read-only review of email/SMS content and delivery readiness for templates, flows, and campaigns. Returns validation, spam score for email, SMS segment info, preflight checks, and editor/preview URLs. This never approves delivery and never sends test messages.
- [nitro_send_test_message](/mcp#operation-nitro-send-test-message-tool): tool — Send a real test message for an existing template, campaign, or flow step.
- [nitro_control_delivery](/mcp#operation-nitro-control-delivery-tool): tool — Manage delivery lifecycle for flows and campaigns. State: draft -> approve -> live/schedule <> pause, cancel -> archive. Use archive for cleanup history, or delete confirmed never-sent drafts.
- [nitro_get_insights](/mcp#operation-nitro-get-insights-tool): tool — Get email analytics with trends, benchmarks, and recommendations.
- [nitro_configure_providers](/mcp#operation-nitro-configure-providers-tool): tool — Configure BYO email provider credentials or check provider status.
- [nitro_set_memory](/mcp#operation-nitro-set-memory-tool): tool — Read or update the AI memory document. Operations: read (get current), update (replace entirely), patch (replace a ## section by heading), append (add text to end).
- [nitro_manage_billing](/mcp#operation-nitro-manage-billing-tool): tool — Manage subscription billing — check plan status, start checkout, poll payment, list plans.
- [nitro_send_message](/mcp#operation-nitro-send-message-tool): tool — Send a transactional email or SMS to a single recipient immediately.
- [nitro_request_support](/mcp#operation-nitro-request-support-tool): tool — Submit a support request to the Nitrosend team. Only call when the user explicitly asks to contact support or when you have exhausted other options and cannot resolve their issue. Never suggest or mention this tool proactively. Before calling, summarize the issue and attempt to resolve it with available tools first.
- [guide](/mcp#operation-nitro-guide-resource): resource — The platform guide your AI reads before doing anything. Covers Nitrosend vocabulary (contacts, channels, flows, campaigns, templates, segments), the two operating modes (tool-driven and goal-driven), the recommended workflow sequence, volume and tier constraints, and common pitfalls to avoid. Read this first.
- [account](/mcp#operation-nitro-account-resource): resource — Live snapshot of the current account context: account, brand, sender identity, dashboard links, tier (free / paid / trusted), email and SMS volume used vs caps, onboarding checklist progress, contact and list counts, and active flow/campaign summary.
- [schema](/mcp#operation-nitro-schema-resource): resource — Machine-readable schema for composing emails and flows. Includes every email section type (header, text, image, button, columns, product, social, divider, spacer, footer) with required and optional props, all flow step types with their parameters, trigger event names, and the full list of segment filter names and predicates.
- [brand](/mcp#operation-nitro-brand-resource): resource — The account's brand identity as configured in Brand Settings. Returns brand_color, text_color, bg_color, font_heading, font_body, logo_url, company_name, company_description, physical_address, and the brand voice document. Your AI reads this automatically when composing emails so designs match the brand.
- [providers](/mcp#operation-nitro-providers-resource): resource — Current email provider configuration and health. Shows whether the account uses Nitrosend's managed SES or a BYO provider (Mailgun, SES), domain verification status for each sending domain, and the active sending mode (sandbox vs production).
- [config](/mcp#operation-nitro-config-resource): resource — Account-level sender defaults: from_name, from_email, reply_to, and saved test email recipients. These are applied automatically to campaigns and flows when per-message overrides are not specified.
- [email-design](/mcp#operation-nitro-email-design-resource): resource — Deep email design reference for campaign, template, or flow email sections. Composition contracts already include selected design capsules; read this only when deeper archetype, color, imagery, whitespace, footer, or section-translation context is needed.
- [email-marketing](/mcp#operation-nitro-email-marketing-resource): resource — Deep email marketing reference for campaign, template, or flow email content. Composition contracts already include selected marketing capsules; read this only when deeper strategy, audience, lifecycle, copy, deliverability, compliance, or intent context is needed.
- [example-email](/mcp#operation-nitro-examples-email-resource): resource — A complete working email design showing every section type in context — header with logo, hero image, text blocks, buttons, two-column product grid, social links, divider, spacer, and footer with unsubscribe. Use as a copy-paste starting point or reference for prop names, style overrides, and column nesting.
- [example-flow](/mcp#operation-nitro-examples-flow-resource): resource — A complete automation flow example demonstrating all step types: email with inline design, SMS, wait (duration in seconds), split with filter conditions and yes/no branches, emit_event, webhook, subscribe, and unsubscribe. Shows trigger configuration, branching structure, and merge-tag usage.
- [example-campaign](/mcp#operation-nitro-examples-campaign-resource): resource — Complete campaign examples for both email and SMS channels. Shows audience targeting with contact_list_ids and segment_id, scheduled delivery with scheduled_at, inline email design with sections, and SMS body composition.
- [knowledge-index](/mcp#operation-nitro-knowledge-index-resource): resource — Index of built-in email marketing knowledge topics. Returns a list of available slugs with titles and short descriptions. Use a slug with nitro://knowledge/{slug} to read the full topic content. Topics cover deliverability, subject lines, segmentation, automation best practices, and compliance.
- [memory](/mcp#operation-nitro-memory-resource): resource — The operator's persistent AI memory document. Contains business goals, target audience, preferred email strategy, tone of voice notes, and any other context the operator has saved. Your AI reads this automatically to inform decisions about email content, flow design, and campaign targeting. Managed via the nitro_set_memory tool.
- [knowledge-topic](/mcp#operation-nitro-knowledge-slug-resource): resource — Full content for a single knowledge topic. Pass a slug from the knowledge index (e.g. nitro://knowledge/deliverability). Returns a markdown document with actionable guidance your AI can apply when composing emails, building flows, or advising on strategy.
- [prompt](/mcp#operation-nitro-prompts-name-resource): resource — Rendered prompt template by name. Returns structured workflow instructions that guide the AI through multi-step tasks like onboarding a new account, running a campaign review, or setting up a welcome series. Each prompt includes context requirements, step sequence, and expected tool calls.
- [audience-analysis](/mcp#operation-audience-analysis-prompt): prompt — Analyse audience segments and engagement
- [build-email](/mcp#operation-build-email-prompt): prompt — Compose a marketing email
- [build-flow](/mcp#operation-build-flow-prompt): prompt — Create an automated email flow from scratch
- [diagnose-deliverability](/mcp#operation-diagnose-deliverability-prompt): prompt — Diagnose and fix email deliverability issues
- [flow-review](/mcp#operation-flow-review-prompt): prompt — Review and optimise an existing flow
- [onboard-brand](/mcp#operation-onboard-brand-prompt): prompt — Set up brand identity for a new account
- [weekly-report](/mcp#operation-weekly-report-prompt): prompt — Generate a weekly performance report

## CLI

- [CLI overview](/cli/overview): When to reach for the Nitrosend CLI, and what it gives you that chat MCP clients and the REST API can't
- [Install & sign in](/cli/install): Install the Nitrosend CLI, sign in with OAuth or an API key, and confirm your connection
- [Agent mode](/cli/agent-mode): Machine-readable output, stable exit codes, dry-run, and idempotency for CI and agent runners
- [Project config](/cli/project-config): Per-project defaults via .nitrosend.yml — profiles, environments, and the production typed-confirm guard
- [Recipes](/cli/recipes): End-to-end CLI examples for CI pipelines, local operating, and agent runners
- [Command reference](/cli/reference): Full Nitrosend CLI command reference, generated from the CLI's command descriptors

## API Reference

- [Nitrosend API](/api): Multi-channel marketing automation API. Send email campaigns, build
- [Discover the MCP server](/api#operation-mcp-get): GET /mcp — Returns MCP discovery metadata for clients that connect over HTTP.
- [MCP JSON-RPC endpoint](/api#operation-mcp-post): POST /mcp — JSON-RPC endpoint for the Nitrosend MCP server. Read `nitro://account`,
- [Create a new account](/api#operation-v1-signup-post): POST /v1/signup
- [Sign in and receive a JWT](/api#operation-v1-login-post): POST /v1/login
- [Sign out and revoke JWT](/api#operation-v1-logout-delete): DELETE /v1/logout
- [Get OAuth popup context](/api#operation-v1-oauth-me-get): GET /v1/oauth/me — Returns the account-selection and subscription context used by the
- [Subscribe the selected OAuth popup account](/api#operation-v1-oauth-subscribe-post): POST /v1/oauth/subscribe — Finalizes plan selection for the `/oauth/connect` popup before the
- [Create a CSRF-safe OAuth provider launch URL](/api#operation-v1-oauth-launch-post): POST /v1/oauth/launch — Mints a short-lived launch URL for Google or GitHub sign-in. The
- [Get current user profile](/api#operation-v1-my-user-get): GET /v1/my/user
- [Update current user profile](/api#operation-v1-my-user-patch): PATCH /v1/my/user
- [Get current impersonation status](/api#operation-v1-my-impersonation-get): GET /v1/my/impersonation
- [Revoke the active impersonation session](/api#operation-v1-my-impersonation-delete): DELETE /v1/my/impersonation
- [Get account details](/api#operation-v1-my-account-get): GET /v1/my/account
- [Update account settings](/api#operation-v1-my-account-patch): PATCH /v1/my/account
- [List accessible accounts](/api#operation-v1-my-accounts-get): GET /v1/my/accounts
- [Get team metadata for the current account](/api#operation-v1-my-account-team-get): GET /v1/my/account/team
- [List account memberships](/api#operation-v1-my-account-memberships-get): GET /v1/my/account/memberships
- [Remove a membership](/api#operation-v1-my-account-memberships-id-delete): DELETE /v1/my/account/memberships/{id}
- [Update a membership role](/api#operation-v1-my-account-memberships-id-patch): PATCH /v1/my/account/memberships/{id}
- [Create a subscription](/api#operation-v1-my-subscription-post): POST /v1/my/subscription
- [Change the current subscription plan](/api#operation-v1-my-subscription-change-put): PUT /v1/my/subscription/change
- [Preview a promotion code or coupon for a subscription plan](/api#operation-v1-my-subscription-coupon-preview-post): POST /v1/my/subscription/coupon_preview — Validates a customer-entered Stripe promotion code or coupon ID against
- [List account invites](/api#operation-v1-my-account-invites-get): GET /v1/my/account/invites
- [Create an account invite](/api#operation-v1-my-account-invites-post): POST /v1/my/account/invites
- [Revoke an invite](/api#operation-v1-my-account-invites-id-delete): DELETE /v1/my/account/invites/{id}
- [Accept an invite token](/api#operation-v1-my-account-invites-id-accept-post): POST /v1/my/account/invites/{id}/accept
- [List contacts (paginated)](/api#operation-v1-my-contacts-get): GET /v1/my/contacts
- [Create a contact](/api#operation-v1-my-contacts-post): POST /v1/my/contacts
- [Get a contact](/api#operation-v1-my-contacts-id-get): GET /v1/my/contacts/{id}
- [Delete a contact](/api#operation-v1-my-contacts-id-delete): DELETE /v1/my/contacts/{id}
- [Update a contact](/api#operation-v1-my-contacts-id-patch): PATCH /v1/my/contacts/{id}
- [Re-enrich a contact via email verification + Apollo](/api#operation-v1-my-contacts-id-enrich-post): POST /v1/my/contacts/{id}/enrich — Queues the contact for email verification and Apollo enrichment.
- [Ingest an image for email designs](/api#operation-v1-my-images-post): POST /v1/my/images — REST adapter over the same image ingest capability used by MCP. Accepts raw base64 bytes or a data URL.
- [List import jobs](/api#operation-v1-my-imports-get): GET /v1/my/imports
- [Start a CSV import](/api#operation-v1-my-imports-post): POST /v1/my/imports — Uploads a CSV file and enqueues an import job. Poll `GET
- [Get import schema metadata](/api#operation-v1-my-imports-spec-get): GET /v1/my/imports/spec
- [Get import job status](/api#operation-v1-my-imports-id-get): GET /v1/my/imports/{id}
- [Delete an import record](/api#operation-v1-my-imports-id-delete): DELETE /v1/my/imports/{id}
- [Cancel a pending or processing import](/api#operation-v1-my-imports-id-cancel-post): POST /v1/my/imports/{id}/cancel
- [List contact lists (paginated)](/api#operation-v1-my-lists-get): GET /v1/my/lists
- [Create a contact list](/api#operation-v1-my-lists-post): POST /v1/my/lists
- [Get a contact list](/api#operation-v1-my-lists-id-get): GET /v1/my/lists/{id}
- [Delete a contact list](/api#operation-v1-my-lists-id-delete): DELETE /v1/my/lists/{id}
- [Update a contact list](/api#operation-v1-my-lists-id-patch): PATCH /v1/my/lists/{id}
- [Get delete warning metadata for a contact list](/api#operation-v1-my-lists-id-delete-warning-get): GET /v1/my/lists/{id}/delete_warning
- [Add or remove existing contacts from a list by email](/api#operation-v1-my-lists-id-contacts-bulk-post): POST /v1/my/lists/{id}/contacts/bulk — Public REST equivalent of the list membership batch primitive. The
- [List all segments](/api#operation-v1-my-segments-get): GET /v1/my/segments
- [Create a segment](/api#operation-v1-my-segments-post): POST /v1/my/segments
- [Get a segment](/api#operation-v1-my-segments-id-get): GET /v1/my/segments/{id}
- [Delete a segment](/api#operation-v1-my-segments-id-delete): DELETE /v1/my/segments/{id}
- [Update a segment](/api#operation-v1-my-segments-id-patch): PATCH /v1/my/segments/{id}
- [Count contacts matching filters](/api#operation-v1-my-segments-count-post): POST /v1/my/segments/count — Preview how many contacts match a set of segment filters
- [List campaigns (paginated)](/api#operation-v1-my-campaigns-get): GET /v1/my/campaigns
- [Create a campaign](/api#operation-v1-my-campaigns-post): POST /v1/my/campaigns
- [Get a campaign](/api#operation-v1-my-campaigns-id-get): GET /v1/my/campaigns/{id}
- [Delete a campaign](/api#operation-v1-my-campaigns-id-delete): DELETE /v1/my/campaigns/{id}
- [Update a campaign](/api#operation-v1-my-campaigns-id-patch): PATCH /v1/my/campaigns/{id} — Updates the campaign. When the campaign is no longer editable (see the
- [Duplicate a campaign](/api#operation-v1-my-campaigns-id-duplicate-post): POST /v1/my/campaigns/{id}/duplicate — Creates a new draft campaign that copies the source's audience
- [Render a campaign email to HTML](/api#operation-v1-my-campaigns-id-render-get): GET /v1/my/campaigns/{id}/render — Renders the campaign's current template through the shared preview renderer.
- [Get current campaign delivery progress](/api#operation-v1-my-campaigns-id-delivery-get): GET /v1/my/campaigns/{id}/delivery — Polls the current campaign send using the same `Campaign::SendProgress`
- [Send a test email for a campaign](/api#operation-v1-my-campaigns-id-send-test-post): POST /v1/my/campaigns/{id}/send_test — Thin adapter over the same test-send service used by template tests.
- [Send a campaign](/api#operation-v1-my-campaigns-id-send-post): POST /v1/my/campaigns/{id}/send — Transitions the campaign and its flow to live, then delivers.
- [List all templates](/api#operation-v1-my-templates-get): GET /v1/my/templates — Returns a summary view with section counts (not full design).
- [Create a standalone template](/api#operation-v1-my-templates-post): POST /v1/my/templates
- [Get a template with full design](/api#operation-v1-my-templates-id-get): GET /v1/my/templates/{id}
- [Update a template](/api#operation-v1-my-templates-id-patch): PATCH /v1/my/templates/{id}
- [Render an existing template to HTML](/api#operation-v1-my-templates-id-render-get): GET /v1/my/templates/{id}/render — Renders the template through the shared preview renderer.
- [Send a test email](/api#operation-v1-my-templates-id-send-test-post): POST /v1/my/templates/{id}/send_test — Send a test email for the given template. Provide `email` for an
- [Render an email design to HTML](/api#operation-v1-my-templates-preview-post): POST /v1/my/templates/preview
- [Get the email component schema](/api#operation-v1-my-templates-spec-get): GET /v1/my/templates/spec — Returns the full schema for email design sections including all
- [List email starter designs](/api#operation-v1-my-templates-starters-get): GET /v1/my/templates/starters — Returns config-based starter email designs with the current brand's
- [AI-generate an email template](/api#operation-v1-my-templates-generate-post): POST /v1/my/templates/generate — Generate a complete email design from a text goal using AI. Returns a
- [List automation flows (paginated)](/api#operation-v1-my-flows-get): GET /v1/my/flows — Returns standalone flows only (excludes campaign-attached flows).
- [Create a flow](/api#operation-v1-my-flows-post): POST /v1/my/flows
- [Get a flow](/api#operation-v1-my-flows-id-get): GET /v1/my/flows/{id}
- [Delete a flow](/api#operation-v1-my-flows-id-delete): DELETE /v1/my/flows/{id}
- [Update a flow](/api#operation-v1-my-flows-id-patch): PATCH /v1/my/flows/{id} — Supports optimistic concurrency — pass `updated_at` to reject
- [Get the flow step type schema](/api#operation-v1-my-flows-spec-get): GET /v1/my/flows/spec — Returns the schema for flow step types, trigger events, and
- [List events (paginated)](/api#operation-v1-my-events-get): GET /v1/my/events
- [Track a contact event](/api#operation-v1-my-events-post): POST /v1/my/events — Requires an idempotency key via the `Idempotency-Key` header or
- [Get an event](/api#operation-v1-my-events-id-get): GET /v1/my/events/{id}
- [Delete an event](/api#operation-v1-my-events-id-delete): DELETE /v1/my/events/{id}
- [List sending domains (paginated)](/api#operation-v1-my-domains-get): GET /v1/my/domains
- [Add a sending domain](/api#operation-v1-my-domains-post): POST /v1/my/domains — Initiates domain verification. Returns DNS records that must be
- [Get a domain with DNS records and status](/api#operation-v1-my-domains-id-get): GET /v1/my/domains/{id}
- [Remove a sending domain](/api#operation-v1-my-domains-id-delete): DELETE /v1/my/domains/{id}
- [Verify domain DNS records](/api#operation-v1-my-domains-id-verify-post): POST /v1/my/domains/{id}/verify — Checks if the required DNS records have propagated. If verified,
- [Create an Entri bootstrap session for a pending domain](/api#operation-v1-my-domains-id-entri-session-post): POST /v1/my/domains/{id}/entri_session — Returns a short-lived Entri JWT plus the DNS record payload needed to
- [List integrations (paginated)](/api#operation-v1-my-integrations-get): GET /v1/my/integrations
- [Create or connect an email provider integration](/api#operation-v1-my-integrations-post): POST /v1/my/integrations
- [Get an integration](/api#operation-v1-my-integrations-id-get): GET /v1/my/integrations/{id}
- [Disconnect and delete an integration](/api#operation-v1-my-integrations-id-delete): DELETE /v1/my/integrations/{id}
- [Update an email provider integration](/api#operation-v1-my-integrations-id-patch): PATCH /v1/my/integrations/{id} — Updates credentials or operational fields for an existing email provider.
- [Test integration connectivity](/api#operation-v1-my-integrations-id-test-post): POST /v1/my/integrations/{id}/test
- [Set an integration as the primary provider for its category](/api#operation-v1-my-integrations-id-primary-patch): PATCH /v1/my/integrations/{id}/primary
- [Start Attio OAuth connect flow](/api#operation-v1-my-integrations-attio-connect-post): POST /v1/my/integrations/attio/connect — Returns an Attio OAuth authorize URL for the authenticated account/brand.
- [Start HubSpot OAuth connect flow](/api#operation-v1-my-integrations-hubspot-connect-post): POST /v1/my/integrations/hubspot/connect — Returns a HubSpot OAuth authorize URL for the authenticated account/brand.
- [Attio OAuth callback endpoint](/api#operation-integrations-attio-callback-get): GET /integrations/attio/callback — Public callback endpoint used by Attio after user authorization.
- [HubSpot OAuth callback endpoint](/api#operation-integrations-hubspot-callback-get): GET /integrations/hubspot/callback — Public callback endpoint used by HubSpot after user authorization.
- [List brands](/api#operation-v1-my-brands-get): GET /v1/my/brands
- [Create a brand](/api#operation-v1-my-brands-post): POST /v1/my/brands
- [Get a brand](/api#operation-v1-my-brands-sid-get): GET /v1/my/brands/{sid}
- [Delete a brand](/api#operation-v1-my-brands-sid-delete): DELETE /v1/my/brands/{sid}
- [Update a brand](/api#operation-v1-my-brands-sid-patch): PATCH /v1/my/brands/{sid}
- [Auto-detect brand from website](/api#operation-v1-my-brands-sid-scrape-post): POST /v1/my/brands/{sid}/scrape — Enqueues a background job that scrapes the URL for brand colors,
- [Get brand onboarding state](/api#operation-v1-my-brands-sid-onboarding-get): GET /v1/my/brands/{sid}/onboarding
- [Complete a brand onboarding step](/api#operation-v1-my-brands-sid-onboarding-steps-post): POST /v1/my/brands/{sid}/onboarding/steps
- [Get brand setup center state](/api#operation-v1-my-brands-sid-setup-center-get): GET /v1/my/brands/{sid}/setup_center
- [Update brand setup center state](/api#operation-v1-my-brands-sid-setup-center-patch): PATCH /v1/my/brands/{sid}/setup_center
- [List messages](/api#operation-v1-my-messages-get): GET /v1/my/messages — Returns transactional messages by default. Use source_type=all to include
- [Send a transactional message](/api#operation-v1-my-messages-post): POST /v1/my/messages — Send a transactional email or SMS to a single recipient immediately.
- [Get a transactional message](/api#operation-v1-my-messages-id-get): GET /v1/my/messages/{id}
- [List persisted chat sessions](/api#operation-v1-my-chat-sessions-get): GET /v1/my/chat_sessions
- [Get a persisted chat session with ordered messages](/api#operation-v1-my-chat-sessions-id-get): GET /v1/my/chat_sessions/{id}
- [Close an active persisted chat session](/api#operation-v1-my-chat-sessions-id-close-patch): PATCH /v1/my/chat_sessions/{id}/close
- [Create or update a public contact (website forms)](/api#operation-v1-public-contacts-post): POST /v1/public/contacts — Public signup endpoint for website forms. Authenticate with a
- [Get available plans](/api#operation-v1-app-get): GET /v1/app