Nitrosend

https://docs.nitrosend.com
Admin
Nitrosend is an AI-native email marketing platform built for developers and marketers to manage...
Tokens:818,991
Snippets:3,799
Trust Score:5.5
Update:9 hours ago
Show doc for...
Tokens:
Raw
### Brand setup and first email workflow

Source: https://docs.nitrosend.com/integrations/vscode

Example prompt for setting up a Brand Kit from a website and drafting a welcome email for new subscribers.

```text
Set up my Brand Kit from https://mysite.com and draft a welcome email for new subscribers.
```

--------------------------------

### Quickstart: Install and initialize Stripe Projects with Nitrosend

Source: https://docs.nitrosend.com/integrations/stripe-projects

Run these commands to install the Stripe Projects plugin, initialize it, add the Nitrosend email resource with a config, and pull the environment variables. The `add` command returns NITROSEND_API_KEY, NITROSEND_API_URL, NITROSEND_MCP_URL, NITROSEND_BRAND_SID, and NITROSEND_FROM_ADDRESS. The sender is `hello@<company>.nitrosend.net`, reserved for you and activated on your first send; no DNS is needed. If you omit `company_name`, the CLI asks for it before the sender can be reserved.

```bash
stripe plugin install projects
stripe projects init
stripe projects add nitrosend/email --config '{"company_name":"Acme Coffee","website":"https://acme.example"}'
stripe projects env --pull
```

--------------------------------

### GET /v1/my/brands/{sid}/setup_center

Source: https://docs.nitrosend.com/api

Retrieves the setup center state for a brand, including onboarding recommendations, card progress, and delivery capacity recovery information.

```APIDOC
## GET /v1/my/brands/{sid}/setup_center

### Description
Retrieves the setup center state for a brand, including onboarding recommendations, card progress, and delivery capacity recovery information.

### Method
GET

### Endpoint
https://api.nitrosend.com/v1/my/brands/{sid}/setup_center

### Parameters
#### Path Parameters
- **sid** (string) - Required - Brand secure identifier

### Response
#### Success Response (200)
- **next_actions** (Array<object>) - Read-only onboarding recommendations and requirements. Blocking is scoped to the stated operation; this list never authorizes delivery. Custom-domain connection is optional when a provided sender is ready.
  - **id** (string) - Required - One of: brand, sender, address, contacts, custom_domain, agent
  - **blocking** (boolean) - Required
  - **scope** (string) - Required - One of: email, campaigns_and_flows
  - **state** (string) - Required - One of: action_required, recommended, waiting
- **cards** (Array<SetupCenterCard>) - Setup center cards
  - **id** (string) - One of: brand_kit_scan, dns, import_subscribers, connect_agent
  - **complete** (boolean)
  - **acknowledged** (boolean)
  - **acknowledged_at** (string<date-time> | null)
  - **sections** (object)
    - **required** (Array<string>)
    - **recommended** (Array<string>)
  - **progress** (object) - Each of the four cards counts individually; `total` is always 4 so every client surface shows the same "N of 4".
    - **completed** (integer)
    - **total** (integer)
    - **seen** (boolean)
    - **dismissed** (boolean)
    - **complete** (boolean)
    - **established** (boolean) - True once real accepted email history proves the brand has sent. Drafts, owner tests and operator proof are not activation. Current DNS health and recent analytics cannot reset this state. Independent of `complete` — an established brand may still carry incomplete cards it has chosen to skip. Clients use it to retire setup nudges.

#### Response Example
{
  "next_actions": [
    {
      "id": "brand",
      "blocking": true,
      "scope": "email",
      "state": "action_required"
    }
  ],
  "cards": [
    {
      "id": "brand_kit_scan",
      "complete": false,
      "acknowledged": false,
      "acknowledged_at": null,
      "sections": {
        "required": [],
        "recommended": []
      },
      "progress": {
        "completed": 0,
        "total": 4,
        "seen": false,
        "dismissed": false,
        "complete": false,
        "established": false
      }
    }
  ]
}

#### Error Response (404)
- **capacity_recovery** (DeliveryCapacityRecovery) - Informational recovery at 80 percent used, exhaustion, or when a campaign exceeds remaining allowance. Never denies a send or promises that payment or verification bypasses safety. Actions come from the shared backend projection; only offer verification when new valid proof can improve standing.
  - **state** (string) - Required - One of: approaching, reached, campaign_exceeds_remaining
  - **reason_code** (string) - Required - One of: sending_capacity_warning, sending_capacity_reached
  - **blocking_control** (string) - Required - One of: commercial_capacity
  - **usage_percent** (integer) - Required - Range [0, 100]
  - **requested_quantity** (integer) - >= 0
  - **label** (string) - Required
  - **detail** (string) - Required
  - **capacity** (DeliveryCapacity) - Required
    - **source** (string) - One of: plan, operator_override
    - **window_seconds** (integer)
    - **status** (string) - Required - One of: known, unlimited, not_applicable, unknown, degraded
    - **limit** (integer | null) - Required - >= 0
    - **reserved** (integer | null) - Required - >= 0
    - **accepted** (integer | null) - Required - >= 0
    - **provider_unknown** (integer | null) - Required - >= 0
    - **remaining** (integer | null) - Required - >= 0
    - **upgrade_url** (string<uri>) - Shareable account-specific plan link. Authentication and billing permissions still apply.
    - **retry_at** (string<date-time>) - Recorded retry time, not a guarantee that delivery completes then.
  - **recovery_action** (DeliveryCapacityRecoveryAction) - Required
    - **type** (string) - Required - One of: upgrade_plan, verify_list, contact_owner, manage_provider_billing, contact_support
    - **label** (string) - Required
    - **detail** (string)
    - **url** (string<uri>) - Required
    - **required_role** (string)
  - **recovery_actions** (Array<DeliveryCapacityRecoveryAction>) - Required
    - **type** (string) - Required - One of: upgrade_plan, verify_list, contact_owner, manage_provider_billing, contact_support
    - **label** (string) - Required
    - **detail** (string)
    - **url** (string<uri>) - Required
    - **required_role** (string)
  - **owner_action** (DeliveryCapacityRecoveryAction) - Required
    - **type** (string) - Required - One of: upgrade_plan, verify_list, contact_owner, manage_provider_billing, contact_support
    - **label** (string) - Required
    - **detail** (string)
    - **url** (string<uri>) - Required
    - **required_role** (string)
  - **recovery_action** (object) - Context-specific recovery action, including sending capacity or prepaid funding recovery.
  - **code** (integer) - Required
  - **message** (string) - Required
  - **error** (boolean) - Required
  - **error_code** (string | null) - Optional machine-readable error reason.
  - **provisioning_id** (integer | null) - Existing provisioning row involved in a managed-account conflict.
  - **retryable** (boolean) - Whether retrying the same idempotent operation can succeed.
  - **retry_at** (string<date-time>) - Earliest recommended retry time for a retryable failure.

#### Response Example (404)
{
  "capacity_recovery": {
    "state": "approaching",
    "reason_code": "sending_capacity_warning",
    "blocking_control": "commercial_capacity",
    "usage_percent": 85,
    "requested_quantity": 1000,
    "label": "Approaching capacity",
    "detail": "You are approaching your sending capacity.",
    "capacity": {
      "source": "plan",
      "window_seconds": 3600,
      "status": "known",
      "limit": 10000,
      "reserved": 100,
      "accepted": 8500,
      "provider_unknown": 0,
      "remaining": 1400,
      "upgrade_url": "https://example.com/upgrade",
      "retry_at": "2025-01-01T00:00:00Z"
    },
    "recovery_action": {
      "type": "upgrade_plan",
      "label": "Upgrade plan",
      "detail": "Increase your sending capacity.",
      "url": "https://example.com/upgrade",
      "required_role": "owner"
    },
    "recovery_actions": [],
    "owner_action": {
      "type": "upgrade_plan",
      "label": "Upgrade plan",
      "detail": "Increase your sending capacity.",
      "url": "https://example.com/upgrade",
      "required_role": "owner"
    },
    "recovery_action": {},
    "code": 404,
    "message": "Resource not found",
    "error": true,
    "error_code": null,
    "provisioning_id": null,
    "retryable": false,
    "retry_at": null
  }
}
```

--------------------------------

### Prompt to set up email flow

Source: https://docs.nitrosend.com/quickstart

Use this prompt to get a full setup in one go. Your AI will scrape your brand, suggest a flow, build it, and walk you through sending a test.

```text
Connect into Nitrosend and based on my brand, give me a suggested email
flow to set up and guide me through set up. Make the email design modern
and on brand against my website.
```

--------------------------------

### Install Nitrosend plugin in Cursor with /add-plugin

Source: https://docs.nitrosend.com/integrations/cursor

Run this command in Cursor's Agent chat to install the official Nitrosend plugin from the Cursor Marketplace. This is the recommended setup method.

```text
/add-plugin nitrosend
```

--------------------------------

### Use Gemini CLI to create a welcome flow

Source: https://docs.nitrosend.com/integrations/gemini

Example Gemini CLI command to create a welcome flow that sends 3 emails over a week when someone subscribes. Requires MCP server setup and sign-in.

```bash
gemini "Create a welcome flow that sends 3 emails over a week when someone subscribes"
```

--------------------------------

### Use Gemini CLI to create a campaign for product launch

Source: https://docs.nitrosend.com/integrations/gemini

Example Gemini CLI command to create a campaign for a product launch and target a VIP segment. Requires MCP server setup and sign-in.

```bash
gemini "Create a campaign for our product launch and target my VIP segment"
```

--------------------------------

### Use Codex to check account and list campaigns

Source: https://docs.nitrosend.com/integrations/codex

Example command to start Codex CLI and ask it to check account status and list recent campaigns.

```bash
codex "Check my Nitrosend account status and list my recent campaigns"
```

--------------------------------

### Use Gemini CLI to check campaign performance

Source: https://docs.nitrosend.com/integrations/gemini

Example Gemini CLI command to show insights for the last campaign compared to benchmarks. Requires MCP server setup and sign-in.

```bash
gemini "Show me insights for my last campaign compared to benchmarks"
```

--------------------------------

### Use Gemini CLI to scrape Brand Kit and draft announcement

Source: https://docs.nitrosend.com/integrations/gemini

Example Gemini CLI command to scrape a Brand Kit from a website and draft a product announcement email. Requires MCP server setup and sign-in.

```bash
gemini "Scrape my Brand Kit from https://mysite.com and draft a product announcement email"
```

--------------------------------

### Check performance

Source: https://docs.nitrosend.com/integrations/claude-code

Example prompt to get insights for the last campaign.

```text
Show me insights for my last campaign. How did it compare to benchmarks?
```

--------------------------------

### Use Nitrosend from Codex CLI

Source: https://docs.nitrosend.com/integrations/codex

Example commands to interact with Nitrosend through Codex CLI after MCP setup. No API key is required for the standard MCP setup.

```bash
codex "Check my Nitrosend account status"
codex "Create a welcome email flow for new subscribers"
codex "Send our newsletter to the active subscribers list"
```

--------------------------------

### Set up Brand Kit and memory

Source: https://docs.nitrosend.com/integrations/claude-code

Example prompt to set up Brand Kit and update AI memory.

```text
Set up my Brand Kit from https://mysite.com and then update my AI memory with 
our Q1 marketing goals.
```

--------------------------------

### Example workflow: Set up Brand Kit and draft email

Source: https://docs.nitrosend.com/integrations/zed

Example prompt for Zed's AI assistant to set up a Brand Kit from a website and draft a welcome email.

```text
Set up my Brand Kit from https://mysite.com and draft a welcome email.
```

--------------------------------

### Example workflow: Create campaign

Source: https://docs.nitrosend.com/integrations/zed

Example prompt for Zed's AI assistant to create a campaign targeting a specific list.

```text
Create a campaign called "Product Update" targeting my main list.
```

--------------------------------

### Create a welcome flow

Source: https://docs.nitrosend.com/integrations/claude-code

Example prompt to create a welcome email flow with a follow-up.

```text
Create a welcome email flow. When a new contact is added, send a welcome 
email immediately, wait 3 days, then send a follow-up with our top 
recommendations.
```

--------------------------------

### GET /integrations/stripe/install

Source: https://docs.nitrosend.com/api

Public entry point for the Stripe App Marketplace install URL. Sets a nonce cookie and redirects to the Stripe App install link for the requested mode. The callback provisions a Nitrosend account for a new email, or asks an existing user to sign in and connect from the integrations page.

```APIDOC
## GET /integrations/stripe/install

### Description
Public entry point for the Stripe App Marketplace install URL. Sets a nonce cookie and redirects to the Stripe App install link for the requested mode. The callback provisions a Nitrosend account for a new email, or asks an existing user to sign in and connect from the integrations page.

### Method
GET

### Endpoint
https://api.nitrosend.com/integrations/stripe/install

### Parameters
#### Query Parameters
- **mode** (string) - Required - The mode for the install link. Possible values: `live`, `test`.

### Response
#### Success Response (302)
Redirect to the Stripe App install link

#### Error Response (404)
The Stripe App is not configured

### Authorization
`BearerAuth` http (bearer)

Authentication scheme depends on the route:
- Authenticated endpoints (`/v1/my/*`) accept a server API key (`nskey_live_...`), a Nitrosend JWT, or a verified Shopify App Bridge ID token for an active embedded installation. API key is checked first.
- Public website-form endpoints (`/v1/public/*`) require a brand public key (`wpkey_live_...`). Secret keys (`nskey_live_...`) are rejected here so they can't be smuggled into browser code.

For accounts with multiple brands, include the `X-Brand-SID` header to scope requests to a specific brand. If omitted, the account's default brand is used. JWT requests can also include `X-Account-ID` to select an accessible account.
```

--------------------------------

### POST /v1/my/integrations/stripe/connect

Source: https://docs.nitrosend.com/api

Starts the Stripe App OAuth connect flow. Returns the Nitrosend Stripe App install link for the authenticated account and brand. The link carries a signed state and the API callback URI; installing the app grants Nitrosend read access to customers, subscriptions, invoices, charges, refunds and events. Pass mode: test for the app's test-mode install link.

```APIDOC
## [POST] /v1/my/integrations/stripe/connect

### Description
Returns the Nitrosend Stripe App install link for the authenticated account and brand. The link carries a signed state and the API callback URI; installing the app grants Nitrosend read access to customers, subscriptions, invoices, charges, refunds and events. Pass `mode: test` for the app's test-mode install link. No keys are pasted; tokens are refreshed server-side. Events for connected accounts arrive on `/hooks/stripe_apps`, isolated from Nitrosend billing webhooks at `/hooks/stripe`.

### Method
POST

### Endpoint
https://api.nitrosend.com/v1/my/integrations/stripe/connect

### Parameters
#### Request Body
- `stripe` (object) - Required - Contains the mode for the Stripe App install link.
  - `mode` (string) - Required - The mode for the install link. Allowed values: `live`, `test`. Default: `live`.

### Request Example
{
  "stripe": {
    "mode": "test"
  }
}

### Response
#### Success Response (200)
- `authorize_url` (string<uri>) - Required - OAuth authorize URL.

#### Response Example
{
  "authorize_url": "https://connect.stripe.com/oauth/authorize?response_type=code&client_id=..."
}

#### Error Response (401)
- `capacity_recovery` (DeliveryCapacityRecovery) - Informational recovery at 80 percent used, exhaustion, or when a campaign exceeds remaining allowance. Never denies a send or promises that payment or verification bypasses safety. Actions come from the shared backend projection; only offer verification when new valid proof can improve standing.
  - `state` (string) - Required - Allowed values: `approaching`, `reached`, `campaign_exceeds_remaining`.
  - `reason_code` (string) - Required - Allowed values: `sending_capacity_warning`, `sending_capacity_reached`.
  - `blocking_control` (string) - Required - Allowed value: `commercial_capacity`.
  - `usage_percent` (integer) - Required - Range: [0, 100].
  - `requested_quantity` (integer) - Optional - >= 0.
  - `label` (string) - Required.
  - `detail` (string) - Required.
  - `capacity` (DeliveryCapacity) - Required.
    - `source` (string) - Allowed values: `plan`, `operator_override`.
    - `window_seconds` (integer) - Optional.
    - `status` (string) - Required - Allowed values: `known`, `unlimited`, `not_applicable`, `unknown`, `degraded`.
    - `limit` (integer|null) - Required - >= 0.
    - `reserved` (integer|null) - Required - >= 0.
    - `accepted` (integer|null) - Required - >= 0.
    - `provider_unknown` (integer|null) - Required - >= 0.
    - `remaining` (integer|null) - Required - >= 0.
    - `upgrade_url` (string<uri>) - Optional - Shareable account-specific plan link. Authentication and billing permissions still apply.
    - `retry_at` (string<date-time>) - Optional - Recorded retry time, not a guarantee that delivery completes then.
  - `recovery_action` (DeliveryCapacityRecoveryAction) - Required.
    - `type` (string) - Required - Allowed values: `upgrade_plan`, `verify_list`, `contact_owner`, `manage_provider_billing`, `contact_support`.
    - `label` (string) - Required.
    - `detail` (string) - Optional.
    - `url` (string<uri>) - Required.
    - `required_role` (string) - Optional.
  - `recovery_actions` (Array<DeliveryCapacityRecoveryAction>) - Required.
    - Each item has same structure as `recovery_action`.
  - `owner_action` (DeliveryCapacityRecoveryAction) - Required.
    - Same structure as `recovery_action`.
  - `recovery_action` (object) - Optional - Context-specific recovery action, including sending capacity or prepaid funding recovery.
  - `code` (integer) - Required.
  - `message` (string) - Required.
  - `error` (boolean) - Required.
  - `error_code` (string|null) - Optional - Machine-readable error reason.
  - `provisioning_id` (integer|null) - Optional - Existing provisioning row involved in a managed-account conflict.
  - `retryable` (boolean) - Optional - Whether retrying the same idempotent operation can succeed.
  - `retry_at` (string<date-time>) - Optional - Earliest recommended retry time for a retryable failure.
  - `missing_scopes` (Array<string>) - Optional - Allowed values: `read_customers`, `read_orders`, `read_products`.
  - `validation_errors` (object) - Optional - Map of field names to arrays of error messages.

#### Error Response (422)
- `code` (integer) - Required.
- `message` (string) - Required.
- `error` (boolean) - Required.
- `error_code` (string|null) - Optional - Machine-readable error reason.
- `provisioning_id` (integer|null) - Optional - Existing provisioning row involved in a managed-account conflict.
- `retryable` (boolean) - Optional - Whether retrying the same idempotent operation can succeed.
- `retry_at` (string<date-time>) - Optional - Earliest recommended retry time for a retryable failure.
- `missing_scopes` (Array<string>) - Optional - Allowed values: `read_customers`, `read_orders`, `read_products`.
- `validation_errors` (object) - Optional - Map of field names to arrays of error messages.

### Authorization
- `BearerAuth` (http bearer) - Authentication scheme depends on the route:
  - Authenticated endpoints (`/v1/my/*`) accept a server API key (`nskey_live_...`), a Nitrosend JWT, or a verified Shopify App Bridge ID token for an active embedded installation. API key is checked first.
  - Public website-form endpoints (`/v1/public/*`) require a brand public key (`wpkey_live_...`). Secret keys (`nskey_live_...`) are rejected here so they can't be smuggled into browser code.
  - For accounts with multiple brands, include the `X-Brand-SID` header to scope requests to a specific brand. If omitted, the account's default brand is used. JWT requests can also include `X-Account-ID` to select an accessible account.
```

--------------------------------

### Sign up without a browser

Source: https://docs.nitrosend.com/cli/install

Create an account from the CLI (0.3.8 or later). The password is read from stdin, never from a flag. It creates the account, makes an API key for its brand, and stores that key as the profile.

```bash
printf '%s' "$PASSWORD" | nitrosend signup --email you@example.com --password-stdin
```

--------------------------------

### Verify CLI setup with login, whoami, and dashboard

Source: https://docs.nitrosend.com/cli/overview

Run these three commands to confirm the CLI is wired up to your account. `nitrosend login` runs OAuth in your browser, `whoami` prints the active profile and API endpoint, and the bare `nitrosend` invocation runs the dashboard.

```bash
nitrosend login
nitrosend whoami
nitrosend
```
Tokens:
Raw