# Nudgen ## Guides ### Getting started - [Introduction](https://docs.nudgen.net/en/index.md): Retention email automation for shop owners and growing SMEs to boost customer lifetime value. - [Quickstart](https://docs.nudgen.net/en/quickstart.md): Launch your first Nudgen campaign in minutes - [Onboarding checklist](https://docs.nudgen.net/en/getting-started/checklist.md): First-week setup steps for your workspace - [Roadmap](https://docs.nudgen.net/en/roadmap.md): Upcoming features and product direction - [Community](https://docs.nudgen.net/en/community.md): Follow Nudgen on social ### Contacts - [Contacts overview](https://docs.nudgen.net/en/contacts/overview.md): How Nudgen stores, encrypts, and displays your contact data - [Upload contacts](https://docs.nudgen.net/en/contacts/upload.md): CSV format, validation rules, and tag assignment for contact uploads - [Contact lifecycle](https://docs.nudgen.net/en/contacts/lifecycle.md): Import, updates, unsubscribes, and suppression ### Map Leads - [Map Leads](https://docs.nudgen.net/en/map-leads/overview.md): Find local businesses by location and category, review contact details, and import selected leads into your workspace ### Integrations - [Integrations overview](https://docs.nudgen.net/en/integrations/overview.md): Find an app and understand what its connection can do - [Connect an app and sync contacts](https://docs.nudgen.net/en/integrations/connect-and-sync.md): Choose audiences, preview contacts, and manage an integration sync - [Connect Shopify contacts](https://docs.nudgen.net/en/integrations/shopify.md): Authorize Shopify and choose all customers or specific segments - [Lifetime campaign events](https://docs.nudgen.net/en/integrations/lifetime-events.md): Use supported integration events to start lifetime campaigns ### Campaigns - [Campaigns overview](https://docs.nudgen.net/en/campaigns/overview.md): One-shot, drip, and Lifetime campaigns - [Create campaigns](https://docs.nudgen.net/en/campaigns/create.md): Step-by-step campaign wizard, AI generation, preview, and test send - [Use Lifetime campaigns](https://docs.nudgen.net/en/campaigns/lifetime.md): Send one event-triggered nudge to a contact with every authenticated trigger - [Manage campaigns](https://docs.nudgen.net/en/campaigns/manage.md): Edit, send, schedule, and stop campaigns - [Campaign analytics](https://docs.nudgen.net/en/campaigns/analytics.md): Metrics, delivery rates, time-series charts, and recipient activity ### Brand - [Brand overview](https://docs.nudgen.net/en/brand/overview.md): Configure tone presets, custom prompts, and example emails for AI-generated content ### Dashboard - [Dashboard overview](https://docs.nudgen.net/en/dashboard/overview.md): Metrics, charts, and campaign summary ### Settings - [Account settings](https://docs.nudgen.net/en/settings/account.md): Account, workspace, and API key settings overview - [Brand identity](https://docs.nudgen.net/en/settings/brand.md): Configure your brand name, email, logo, and the default language for AI-generated emails - [Team settings](https://docs.nudgen.net/en/settings/team.md): Invite members, manage roles, and handle invitations - [Email signatures](https://docs.nudgen.net/en/settings/signatures.md): Create, edit, and use signatures in campaigns - [Custom domain](https://docs.nudgen.net/en/settings/sending-domains.md): Verify a domain you own and use it as your team's campaign sender ### Billing - [Billing overview](https://docs.nudgen.net/en/billing/overview.md): Plan tiers, usage meters, checkout, and customer portal ### Affiliate - [Affiliate Program](https://docs.nudgen.net/en/affiliate/overview.md): Earn 10% recurring monthly commission for the life of every customer you refer to Nudgen. - [Affiliate FAQ](https://docs.nudgen.net/en/affiliate/faq.md): Common questions about the Nudgen Partner Program. ### Agents - [Email for Agents](https://docs.nudgen.net/en/agents/overview.md): Give Claude Code, Codex, Cursor, OpenClaw and your own agents structured ways to install Nudgen, migrate your stack, send events, and work with Nudgen. - [Agent Skills](https://docs.nudgen.net/en/agents/skills.md): Skills are composable modules that teach your coding agent how to work with Nudgen. Install them with a single command. - [CLI Introduction](https://docs.nudgen.net/en/agents/cli/introduction.md): Master the Nudgen marketing automation platform via its interactive Command Line Interface. - [CLI Installation](https://docs.nudgen.net/en/agents/cli/installation.md): Get started with the Nudgen CLI on macOS, Linux, or Windows. - [CLI Commands](https://docs.nudgen.net/en/agents/cli/commands.md): Reference for all Nudgen CLI commands. - [AI Agent Usage](https://docs.nudgen.net/en/agents/cli/agentic-usage.md): How to use Nudgen CLI as an interface for AI Agents. - [Developer API](https://docs.nudgen.net/en/agents/api.md): REST API for your Nudgen workspace, including event-triggered Lifetime campaigns - [MCP server](https://docs.nudgen.net/en/agents/mcp.md): Connect an AI assistant through OAuth, create drafts, and authorize sending in chat ### Lead Email Finder (Extension) - [Overview](https://docs.nudgen.net/en/extension/overview.md): Extract and verify professional email addresses instantly from social profiles and websites. - [Installation](https://docs.nudgen.net/en/extension/installation.md): How to install the Lead Email Finder on your preferred browser. - [How to use](https://docs.nudgen.net/en/extension/usage.md): Learn how to find, verify, and export leads using the extension. ### Signature Generator - [Signature Generator Overview](https://docs.nudgen.net/en/extension/signature-overview.md): Professional, free email signatures for your brand - [How to Use the Editor](https://docs.nudgen.net/en/extension/signature-usage.md): Customize your professional email signature - [Installation Guide](https://docs.nudgen.net/en/extension/signature-installation.md): Add your signature to your favorite email client ### Spam Checker - [Email Spam Checker](https://docs.nudgen.net/en/spam-checker/overview.md): Verify your email deliverability and identify spam triggers before you send. ### Email Deliverability Audit - [Email Deliverability Audit](https://docs.nudgen.net/en/email-deliverability-audit/overview.md): Audit your domain’s SPF, DKIM, and DMARC records to ensure optimal inbox placement. ### Concepts - [Contact lifecycle](https://docs.nudgen.net/en/concepts/contact-lifecycle.md): How contacts move through import, engagement, and suppression - [Workspaces and roles](https://docs.nudgen.net/en/concepts/workspaces-and-roles.md): Teams, members, and permissions - [Deliverability basics](https://docs.nudgen.net/en/concepts/deliverability-basics.md): How we keep your emails out of spam - [Developers and APIs](https://docs.nudgen.net/en/concepts/developers-and-apis.md): Use Nudgen with Personal Access Tokens for REST and OAuth for MCP ### Troubleshooting & FAQ - [Troubleshooting and FAQ](https://docs.nudgen.net/en/troubleshooting/index.md): Common issues and solutions - [Sending and deliverability](https://docs.nudgen.net/en/troubleshooting/deliverability.md): Emails not sending, bounces, and spam - [Billing and subscriptions](https://docs.nudgen.net/en/troubleshooting/billing.md): Payments, trial, and plan changes - [Access and permissions](https://docs.nudgen.net/en/troubleshooting/access.md): Invitations, roles, and workspace access ### Security & privacy - [Privacy and data](https://docs.nudgen.net/en/security/privacy-and-data.md): How we handle PII, tracking, and third-party providers ### Legal - [Terms of Service](https://docs.nudgen.net/en/legal/terms-of-service.md): Terms of Service for Nudgen LLC governing subscriptions, acceptable use, customer data, and liability limits for the Nudgen platform. - [Privacy Policy](https://docs.nudgen.net/en/legal/privacy-policy.md): Privacy Policy for Nudgen LLC covering account data, customer contact data, email tracking, billing, and security practices. ## API Playground ### API reference - [Get current user](https://docs.nudgen.net/api-reference/identity/get-current-user.md): Returns the authenticated user for the provided Personal Access Token. - [List workspaces](https://docs.nudgen.net/api-reference/identity/list-workspaces.md): Lists workspaces available to the token owner and identifies the active workspace. - [List contacts](https://docs.nudgen.net/api-reference/contacts/list-contacts.md): Lists contacts in the active workspace. Contact PII is decrypted in the authorized response. - [Create contact](https://docs.nudgen.net/api-reference/contacts/create-contact.md): Creates one contact in the active workspace. - [Get contact](https://docs.nudgen.net/api-reference/contacts/get-contact.md) - [Update contact](https://docs.nudgen.net/api-reference/contacts/update-contact.md) - [Delete contact](https://docs.nudgen.net/api-reference/contacts/delete-contact.md) - [List campaigns](https://docs.nudgen.net/api-reference/campaigns/list-campaigns.md): Lists campaigns in the active workspace. - [Create campaign](https://docs.nudgen.net/api-reference/campaigns/create-campaign.md): Creates a campaign draft, scheduled campaign, or immediate send when `sendNow` is true. - [Get campaign](https://docs.nudgen.net/api-reference/campaigns/get-campaign.md) - [Update campaign](https://docs.nudgen.net/api-reference/campaigns/update-campaign.md) - [Launch campaign](https://docs.nudgen.net/api-reference/campaigns/launch-campaign.md): Launches a campaign now or schedules it for a future time. - [Get campaign stats](https://docs.nudgen.net/api-reference/campaigns/get-campaign-stats.md) - [Change lifetime campaign status](https://docs.nudgen.net/api-reference/campaigns/change-lifetime-campaign-status.md): Allowed transitions: draft to active, active to paused or archived, paused to active or archived. Archived campaigns cannot resume. Pausing or archiving cancels pending and queued executions. A lifetime campaign must be created as a draft; the launch endpoint does not accept it. - [Trigger a lifetime campaign](https://docs.nudgen.net/api-reference/campaigns/trigger-a-lifetime-campaign.md): Requires a team API key with campaigns:trigger scope. The key must belong to the campaign workspace. eventId is an idempotency key within this campaign: a duplicate returns the existing execution with HTTP 200. New executions return HTTP 201; suppressed contacts can produce a skipped execution. Limi… - [List lifetime campaign executions](https://docs.nudgen.net/api-reference/campaigns/list-lifetime-campaign-executions.md): Lists execution history for a lifetime campaign in the active workspace. Search treats values containing @ as an exact email lookup; other values search external contact IDs. Invalid status filters are ignored. - [Get brand settings](https://docs.nudgen.net/api-reference/brand-settings/get-brand-settings.md) - [Update brand settings](https://docs.nudgen.net/api-reference/brand-settings/update-brand-settings.md) - [List team API keys](https://docs.nudgen.net/api-reference/team-api-keys/list-team-api-keys.md): Owner or admin only. Raw key secrets are never returned by this endpoint. - [Create team API key](https://docs.nudgen.net/api-reference/team-api-keys/create-team-api-key.md): Owner or admin only. The new key has only the campaigns:trigger scope. Save the raw key from this response because it is shown once. - [Rotate team API key](https://docs.nudgen.net/api-reference/team-api-keys/rotate-team-api-key.md): Owner or admin only. Rotating invalidates the previous key immediately and returns the new raw key once. Revoked or expired keys cannot be rotated. - [Revoke team API key](https://docs.nudgen.net/api-reference/team-api-keys/revoke-team-api-key.md): Owner or admin only. Repeating the request for an already revoked key succeeds. - [List sending domains](https://docs.nudgen.net/api-reference/sending-domains/list-sending-domains.md) - [Add sending domain](https://docs.nudgen.net/api-reference/sending-domains/add-sending-domain.md): Owner or admin only. Custom sender use requires an eligible paid plan. - [Edit sending identity](https://docs.nudgen.net/api-reference/sending-domains/edit-sending-identity.md): Owner or admin only. Updates sender email and sender name for an existing domain. - [Remove sending domain](https://docs.nudgen.net/api-reference/sending-domains/remove-sending-domain.md): Owner or admin only. - [Check sending domain DNS](https://docs.nudgen.net/api-reference/sending-domains/check-sending-domain-dns.md): Owner or admin only. Performs verification after the required DNS records have been published. Requires an eligible paid plan. - [Select default sending domain](https://docs.nudgen.net/api-reference/sending-domains/select-default-sending-domain.md): Owner or admin only. Pass null to clear the custom default. - [Resume campaign sending](https://docs.nudgen.net/api-reference/sending-domains/resume-campaign-sending.md): Owner or admin only. Clears an eligible sender hold after its cause has been resolved. - [Generate email draft](https://docs.nudgen.net/api-reference/ai/generate-email-draft.md): Generates an email subject and HTML draft from campaign context and the active workspace brand settings. - [Search local businesses](https://docs.nudgen.net/api-reference/map-leads/search-local-businesses.md): PAT uses the active workspace. Defaults to a strict 5 km circle; integer radiusKm 1–100 is explicit. Preserve location, keywords, center, place ID and radius on pagination. Empty filtered pages can still have nextPageToken. Only new searches consume daily quota; pagination does not. Increasing radiu… - [Retry pending website enrichment](https://docs.nudgen.net/api-reference/map-leads/retry-pending-website-enrichment.md): Use enrichmentRetryToken from search. Workspace-bound, single-use, expires after 15 minutes; up to 20 server-discovered pending businesses. Does not consume search quota. Merge leads by placeId. A retry may finish without finding an email. Streaming emits progress/complete with data or error with er… - [Import map leads as contacts](https://docs.nudgen.net/api-reference/map-leads/import-map-leads-as-contacts.md): Import 1–200 businesses into the active workspace. Invalid/missing emails are skipped; existing emails are updated. Stores available business summary/sources and source details. Adds map-lead, location and keyword tags. Contact plan limits apply. - [Get daily map search quota](https://docs.nudgen.net/api-reference/map-leads/get-daily-map-search-quota.md): Quota belongs to the active workspace and resets at midnight UTC. Null limit and remaining mean unlimited. - [Suggest search locations](https://docs.nudgen.net/api-reference/map-leads/suggest-search-locations.md): Autocomplete locations. Reuse the sessionToken when resolving the selected place. - [Resolve a location suggestion](https://docs.nudgen.net/api-reference/map-leads/resolve-a-location-suggestion.md): Resolve an autocomplete place ID to search coordinates. This is location resolution, not business contact enrichment. - [Get default map center](https://docs.nudgen.net/api-reference/map-leads/get-default-map-center.md): Returns the fixed fallback center Ho Chi Minh City (10.82, 106.63), VN. Does not locate the caller or use browser GPS. ## OpenAPI Specs - [openapi](/openapi.json) ## Optional - [Home](https://get.nudgen.net) - [Pricing](https://get.nudgen.net/pricing) - [Blog](https://get.nudgen.net/blog) - [Affiliate](https://get.nudgen.net/affiliate) - [Status](https://stats.uptimerobot.com/fGg8sPgh7G) > The links below point to documentation indexes. Follow each `/_llms/` index recursively until you reach documentation pages. ## Indexes - [Arabic (55 pages)](https://docs.nudgen.net/_llms/ar.txt): الأدلة. - [Chinese (55 pages)](https://docs.nudgen.net/_llms/cn.txt): 指南. - [German (55 pages)](https://docs.nudgen.net/_llms/de.txt): Anleitungen. - [Spanish (55 pages)](https://docs.nudgen.net/_llms/es.txt): Guías. - [French (55 pages)](https://docs.nudgen.net/_llms/fr.txt): Guides. - [Indonesian (55 pages)](https://docs.nudgen.net/_llms/id.txt): Panduan. - [Japanese (55 pages)](https://docs.nudgen.net/_llms/jp.txt): ガイド. - [Korean (55 pages)](https://docs.nudgen.net/_llms/ko.txt): 가이드. - [Russian (55 pages)](https://docs.nudgen.net/_llms/ru.txt): Руководства. - [Turkish (55 pages)](https://docs.nudgen.net/_llms/tr.txt): Kılavuzlar. - [Vietnamese (55 pages)](https://docs.nudgen.net/_llms/vi.txt): Hướng dẫn. This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.