> ## Documentation Index
> Fetch the complete documentation index at: https://nango.dev/docs/llms.txt
> Use this file to discover all available pages before exploring further.

# Omnisend

> Integrate your application with the Omnisend API

## 🚀 Quickstart

Connect to Omnisend with Nango and make a read-only request in minutes. Omnisend uses a static API key generated in your Omnisend account.

**1. Create the integration**

In Nango ([free signup](https://app.nango.dev)), go to [Integrations](https://app.nango.dev/dev/integrations) -> *Configure New Integration* -> *Omnisend*.

**2. Authorize Omnisend**

Go to [Connections](https://app.nango.dev/dev/connections) -> *Add Test Connection* -> *Authorize*, then enter an Omnisend API key with only the scopes your application needs. Later, your users can do the same directly from your app.

**3. Call the Omnisend API**

Make a read-only request to list at most one campaign. This requires the `campaigns.read` scope on your API key. Replace the placeholders below with your [Environment API key](https://nango.dev/docs/reference/backend/http-api/api-keys.md), [integration ID](https://app.nango.dev/dev/integrations), and [connection ID](https://app.nango.dev/dev/connections):

> [tab] cURL
>
> ```bash theme={null}
> curl "https://api.nango.dev/proxy/api/campaigns?limit=1" \
>   -H "Authorization: Bearer <NANGO-SECRET-KEY>" \
>   -H "Provider-Config-Key: <INTEGRATION-ID>" \
>   -H "Connection-Id: <CONNECTION-ID>"
> ```

> [tab] Node
>
> Install Nango's backend SDK with `npm i @nangohq/node`. Then run:
>
> ```typescript theme={null}
> import { Nango } from '@nangohq/node';
>
> const nango = new Nango({ secretKey: '<NANGO-SECRET-KEY>' });
>
> const res = await nango.get({
>     endpoint: '/api/campaigns?limit=1',
>     providerConfigKey: '<INTEGRATION-ID>',
>     connectionId: '<CONNECTION-ID>'
> });
>
> console.log(res.data);
> ```

Or fetch credentials with the [Node SDK](https://nango.dev/docs/reference/backend/backend-sdk/node.md#get-a-connection-with-credentials) or [API](https://nango.dev/docs/reference/backend/http-api/connections/get.md).

✅ You're connected! Check the [Logs](https://app.nango.dev/dev/logs) tab in Nango to inspect requests.

**4. Implement Nango in your app**

Follow our [Auth implementation guide](https://nango.dev/docs/guides/primitives/auth.md) to integrate Nango in your app.

To obtain your own Omnisend API key, follow the setup guide below.

## 📚 Omnisend integration guides

Nango maintained guides for common use cases.

* [How do I link my Omnisend account?](https://nango.dev/docs/api-integrations/omnisend/connect)
  Create an Omnisend API key and connect your account

Official docs: [Omnisend API documentation](https://api-docs.omnisend.com/reference/overview)

## 🧩 Pre-built syncs & tools for Omnisend

Explore Nango-provided tools in your dashboard. Extend and customize them to fit your needs.

### Analytics

| Function name | Description | Type |
| - | - | - |
| `post-analytics-reports` | Generate report | [Tool](https://nango.dev/docs/guides/functions/tools.md) |
| `post-analytics-statistics` | Generate statistics | [Tool](https://nango.dev/docs/guides/functions/tools.md) |

### Automations

| Function name | Description | Type |
| - | - | - |
| `delete-automations-id` | Delete automation workflow | [Tool](https://nango.dev/docs/guides/functions/tools.md) |
| `get-automations-id-blocks-block-i-d-utm` | Get UTM tags for an automation block | [Tool](https://nango.dev/docs/guides/functions/tools.md) |
| `get-automations-id-utm` | Get aggregated UTM tags for all blocks | [Tool](https://nango.dev/docs/guides/functions/tools.md) |
| `get-automations-id` | Get automation workflow | [Tool](https://nango.dev/docs/guides/functions/tools.md) |
| `get-automations` | List automation workflows | [Tool](https://nango.dev/docs/guides/functions/tools.md) |
| `patch-automations-id` | Patch automation workflow | [Tool](https://nango.dev/docs/guides/functions/tools.md) |
| `post-automations-id-blocks-block-i-d-test-email` | Send test email | [Tool](https://nango.dev/docs/guides/functions/tools.md) |
| `post-automations-id-copy` | Copy automation workflow | [Tool](https://nango.dev/docs/guides/functions/tools.md) |
| `post-automations-id-disable` | Disable automation workflow | [Tool](https://nango.dev/docs/guides/functions/tools.md) |
| `post-automations-id-enable` | Enable automation workflow | [Tool](https://nango.dev/docs/guides/functions/tools.md) |
| `post-automations` | Create automation workflow | [Tool](https://nango.dev/docs/guides/functions/tools.md) |
| `put-automations-id-blocks-block-i-d-utm` | Update UTM tags for an automation block | [Tool](https://nango.dev/docs/guides/functions/tools.md) |
| `put-automations-id-blocks` | Replace automation workflow blocks | [Tool](https://nango.dev/docs/guides/functions/tools.md) |
| `sync-automation` | Synchronizes Omnisend Automations records. | [Sync](https://nango.dev/docs/guides/functions/syncs/sync-functions.md) |

### Batches

| Function name | Description | Type |
| - | - | - |
| `get-batches-batch-i-d-items` | Get batch items | [Tool](https://nango.dev/docs/guides/functions/tools.md) |
| `get-batches-batch-i-d` | Get batch information | [Tool](https://nango.dev/docs/guides/functions/tools.md) |
| `get-batches` | Get batches | [Tool](https://nango.dev/docs/guides/functions/tools.md) |
| `post-batches` | Create batch | [Tool](https://nango.dev/docs/guides/functions/tools.md) |

### Brands

| Function name | Description | Type |
| - | - | - |
| `get-brands-current` | Get information about brand | [Tool](https://nango.dev/docs/guides/functions/tools.md) |
| `post-brands-current` | Connect brand | [Tool](https://nango.dev/docs/guides/functions/tools.md) |

### Campaigns

| Function name | Description | Type |
| - | - | - |
| `delete-campaigns-id` | Delete campaign | [Tool](https://nango.dev/docs/guides/functions/tools.md) |
| `get-campaigns-id-utm` | Get campaign UTM settings | [Tool](https://nango.dev/docs/guides/functions/tools.md) |
| `get-campaigns-id` | Get campaign | [Tool](https://nango.dev/docs/guides/functions/tools.md) |
| `get-campaigns` | List campaigns with filtering, sorting, and cursor pagination | [Tool](https://nango.dev/docs/guides/functions/tools.md) |
| `patch-campaigns-id` | Update campaign (draft status only) | [Tool](https://nango.dev/docs/guides/functions/tools.md) |
| `post-campaigns-id-ab-test-resume` | Resume A/B test | [Tool](https://nango.dev/docs/guides/functions/tools.md) |
| `post-campaigns-id-ab-test-stop` | Stop A/B test | [Tool](https://nango.dev/docs/guides/functions/tools.md) |
| `post-campaigns-id-ab-test-winner` | Select A/B test winner | [Tool](https://nango.dev/docs/guides/functions/tools.md) |
| `post-campaigns-id-cancel` | Cancel campaign | [Tool](https://nango.dev/docs/guides/functions/tools.md) |
| `post-campaigns-id-copy` | Copy campaign | [Tool](https://nango.dev/docs/guides/functions/tools.md) |
| `post-campaigns-id-send` | Send campaign | [Tool](https://nango.dev/docs/guides/functions/tools.md) |
| `post-campaigns-id-test-email` | Send campaign test email | [Tool](https://nango.dev/docs/guides/functions/tools.md) |
| `post-campaigns` | Create campaign | [Tool](https://nango.dev/docs/guides/functions/tools.md) |
| `put-campaigns-id-utm` | Update campaign UTM settings | [Tool](https://nango.dev/docs/guides/functions/tools.md) |
| `sync-campaign` | Synchronizes Omnisend Campaigns records. | [Sync](https://nango.dev/docs/guides/functions/syncs/sync-functions.md) |

### Contacts

| Function name | Description | Type |
| - | - | - |
| `delete-contacts-tags` | Batch remove tags | [Tool](https://nango.dev/docs/guides/functions/tools.md) |
| `get-contacts-id` | Get contact | [Tool](https://nango.dev/docs/guides/functions/tools.md) |
| `get-contacts` | List contacts | [Tool](https://nango.dev/docs/guides/functions/tools.md) |
| `patch-contacts-id` | Update contact by ID | [Tool](https://nango.dev/docs/guides/functions/tools.md) |
| `patch-contacts` | Update contact by email | [Tool](https://nango.dev/docs/guides/functions/tools.md) |
| `post-contacts-tags` | Batch add tags | [Tool](https://nango.dev/docs/guides/functions/tools.md) |
| `post-contacts` | Create or update existing contact | [Tool](https://nango.dev/docs/guides/functions/tools.md) |
| `sync-contact` | Synchronizes Omnisend Contacts records. | [Sync](https://nango.dev/docs/guides/functions/syncs/sync-functions.md) |

### Email Templates

| Function name | Description | Type |
| - | - | - |
| `sync-email-template` | Synchronizes Omnisend Email Templates records. | [Sync](https://nango.dev/docs/guides/functions/syncs/sync-functions.md) |

### Email Universal Layouts

| Function name | Description | Type |
| - | - | - |
| `sync-email-universal-layout` | Synchronizes Omnisend Email Universal Layouts records. | [Sync](https://nango.dev/docs/guides/functions/syncs/sync-functions.md) |

### EmailContent

| Function name | Description | Type |
| - | - | - |
| `get-email-content-id` | Get email content | [Tool](https://nango.dev/docs/guides/functions/tools.md) |
| `post-email-content-id-render` | Render email content | [Tool](https://nango.dev/docs/guides/functions/tools.md) |
| `put-email-content-id` | Update email content | [Tool](https://nango.dev/docs/guides/functions/tools.md) |

### EmailTemplates

| Function name | Description | Type |
| - | - | - |
| `delete-email-templates-id` | Delete email template | [Tool](https://nango.dev/docs/guides/functions/tools.md) |
| `get-email-templates-id` | Get email template | [Tool](https://nango.dev/docs/guides/functions/tools.md) |
| `get-email-templates` | Get email templates | [Tool](https://nango.dev/docs/guides/functions/tools.md) |
| `post-email-templates-id-render` | Render email template | [Tool](https://nango.dev/docs/guides/functions/tools.md) |
| `post-email-templates-import` | Import email template from HTML | [Tool](https://nango.dev/docs/guides/functions/tools.md) |
| `post-email-templates` | Create email template | [Tool](https://nango.dev/docs/guides/functions/tools.md) |
| `put-email-templates-id` | Update email template | [Tool](https://nango.dev/docs/guides/functions/tools.md) |

### EmailUniversalLayouts

| Function name | Description | Type |
| - | - | - |
| `delete-email-universal-layouts-id` | Delete universal layout | [Tool](https://nango.dev/docs/guides/functions/tools.md) |
| `get-email-universal-layouts-id` | Get universal layout | [Tool](https://nango.dev/docs/guides/functions/tools.md) |
| `get-email-universal-layouts` | Get universal layouts | [Tool](https://nango.dev/docs/guides/functions/tools.md) |
| `post-email-universal-layouts` | Create universal layout | [Tool](https://nango.dev/docs/guides/functions/tools.md) |
| `put-email-universal-layouts-id` | Update universal layout | [Tool](https://nango.dev/docs/guides/functions/tools.md) |

### EventMetadata

| Function name | Description | Type |
| - | - | - |
| `post-event-metadata-query` | Query events metadata | [Tool](https://nango.dev/docs/guides/functions/tools.md) |
| `post-event-metadata` | Create custom event metadata | [Tool](https://nango.dev/docs/guides/functions/tools.md) |
| `put-event-metadata` | Update custom event metadata | [Tool](https://nango.dev/docs/guides/functions/tools.md) |

### Events

| Function name | Description | Type |
| - | - | - |
| `post-events` | Send Customer event | [Tool](https://nango.dev/docs/guides/functions/tools.md) |

### Images

| Function name | Description | Type |
| - | - | - |
| `delete-images-id` | Delete image | [Tool](https://nango.dev/docs/guides/functions/tools.md) |
| `get-images-id` | Get image | [Tool](https://nango.dev/docs/guides/functions/tools.md) |
| `get-images` | List images | [Tool](https://nango.dev/docs/guides/functions/tools.md) |
| `post-images-upload` | Upload image file | [Tool](https://nango.dev/docs/guides/functions/tools.md) |
| `post-images` | Upload image by URL | [Tool](https://nango.dev/docs/guides/functions/tools.md) |
| `sync-image` | Synchronizes Omnisend Images records. | [Sync](https://nango.dev/docs/guides/functions/syncs/sync-functions.md) |

### Product Categories

| Function name | Description | Type |
| - | - | - |
| `sync-product-category` | Synchronizes Omnisend Product Categories records. | [Sync](https://nango.dev/docs/guides/functions/syncs/sync-functions.md) |

### ProductCategories

| Function name | Description | Type |
| - | - | - |
| `delete-product-categories-category-i-d` | Delete product category | [Tool](https://nango.dev/docs/guides/functions/tools.md) |
| `get-product-categories-category-i-d` | Get product category | [Tool](https://nango.dev/docs/guides/functions/tools.md) |
| `get-product-categories` | List product categories | [Tool](https://nango.dev/docs/guides/functions/tools.md) |
| `patch-product-categories-category-i-d` | Update product category | [Tool](https://nango.dev/docs/guides/functions/tools.md) |
| `post-product-categories` | Create product category | [Tool](https://nango.dev/docs/guides/functions/tools.md) |

### Products

| Function name | Description | Type |
| - | - | - |
| `delete-products-product-i-d` | Delete product | [Tool](https://nango.dev/docs/guides/functions/tools.md) |
| `get-products-product-i-d` | Get product | [Tool](https://nango.dev/docs/guides/functions/tools.md) |
| `get-products` | List products | [Tool](https://nango.dev/docs/guides/functions/tools.md) |
| `post-products` | Create product | [Tool](https://nango.dev/docs/guides/functions/tools.md) |
| `put-products-product-i-d` | Replace product | [Tool](https://nango.dev/docs/guides/functions/tools.md) |
| `sync-product` | Synchronizes Omnisend Products records. | [Sync](https://nango.dev/docs/guides/functions/syncs/sync-functions.md) |

### Segments

| Function name | Description | Type |
| - | - | - |
| `delete-segments-segment-i-d` | Delete segment | [Tool](https://nango.dev/docs/guides/functions/tools.md) |
| `get-segments-segment-i-d-statistics` | Get segment statistics | [Tool](https://nango.dev/docs/guides/functions/tools.md) |
| `get-segments-segment-i-d` | Get segment | [Tool](https://nango.dev/docs/guides/functions/tools.md) |
| `get-segments` | List segments | [Tool](https://nango.dev/docs/guides/functions/tools.md) |
| `post-segments` | Create segment | [Tool](https://nango.dev/docs/guides/functions/tools.md) |
| `put-segments-segment-i-d` | Update segment | [Tool](https://nango.dev/docs/guides/functions/tools.md) |
| `sync-segment` | Synchronizes Omnisend Segments records. | [Sync](https://nango.dev/docs/guides/functions/syncs/sync-functions.md) |

***


This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.