Skip to main content

Omnisend

Omnisend is an e-commerce marketing automation platform for email and SMS campaigns and customer data. The Omnisend REST API lets you manage contacts, campaigns, automation workflows, products, segments, and related resources programmatically, enabling Nexla to move data to and from your Omnisend account.

Omnisend icon

Power end-to-end data operations for your Omnisend API with Nexla. Our bi-directional Omnisend connector is purpose-built for Omnisend, making it simple to ingest data, sync it across systems, and deliver it anywhere — all with no coding required. Nexla turns API-sourced data into ready-to-use, reusable data products and makes it easy to send data to Omnisend or any other destination. With comprehensive monitoring, lineage tracking, and access controls, Nexla keeps your Omnisend workflows fast, secure, and fully governed.

Features

Type: API

SourceDestination

  • Seamless API Integration: Connect to any endpoint as source or destination without coding, with automatic data product creation
  • Visual Composition & Chaining: Build complex integrations using visual templates, chain API calls, and compose workflows with data validation and filtering
  • API Proxy: Expose curated slices of your data securely with a secure and customizable API proxy that validates and transforms data on the fly
  • Request optimization with intelligent batching, retry, and caching to minimize API calls and costs

Prerequisites

Before creating an Omnisend credential, you need an Omnisend API key. Omnisend authenticates every REST API request with an API key sent in the X-API-KEY header. The API base URL is https://api.omnisend.com/v5.

To generate an API key, follow these steps:

  1. Sign in to your Omnisend account.

  2. Navigate to Store settings > API keys.

  3. Click Create API key.

  4. Enter a name for the key that identifies the integration (for example, "Nexla Integration").

  5. Select the permissions (scopes) the key should have. Permissions control which Omnisend data the key can access — for example, a key with only Contacts access cannot read or modify Campaigns or Products. Grant the scopes required for the endpoints you plan to use in Nexla.

  6. Click Create API key, then copy the generated key.

    The API key is shown only once. Copy it immediately and store it securely — if you close the screen without copying it, you will need to generate a new key. You can create separate keys for each integration to track usage and revoke access independently.

For complete information about API keys, permissions, and available endpoints, see the Omnisend API documentation and the Generate an API Key in Omnisend help article.

Authenticate

Credentials required

FieldRequiredSecretDescription
API Key ValueYesYesAn encoded string value used as a secret token to authenticate API requests

Create a credential in Nexla

  1. After selecting the data source/destination type, click the Add Credential tile to open the Add New Credential overlay.

  2. Enter a name for the credential in the Credential Name field and a short, meaningful description in the Credential Description field.

  3. Enter your Omnisend API key in the API Key Value field. This key is sent in the X-API-KEY header for all requests to the Omnisend REST API and must be kept confidential.

  4. Click the Save button at the bottom of the overlay. The newly added credential will now appear in a tile on the Authenticate screen during data source/destination creation.

Use as a data source

To create a new data flow, navigate to the Integrate section, and click the New Data Flow button. Select the Omnisend connector tile, then select the credential that will be used to connect to Omnisend, and click Next; or, create a new Omnisend credential for use in this flow.

Endpoint templates

Nexla provides pre-built templates that can be used to rapidly configure data sources to ingest data from common Omnisend endpoints. Select the endpoint from which this source will fetch data from the Endpoint pulldown menu. Available endpoint templates are listed in the expandable boxes below.

[Rest API] List contacts with filtering and pagination

This endpoint template list contacts with filtering and pagination from your Omnisend account. Use it when you need to ingest this data into Nexla, where the results are organized into one or more Nexsets.

[Rest API] Retrieve a contact by ID

This endpoint template retrieve a contact by ID from your Omnisend account. Use it when you need to ingest this data into Nexla, where the results are organized into one or more Nexsets.

[Rest API] List campaigns with filtering and pagination

This endpoint template list campaigns with filtering and pagination from your Omnisend account. Use it when you need to ingest this data into Nexla, where the results are organized into one or more Nexsets.

[Rest API] Retrieve a single campaign

This endpoint template retrieve a single campaign from your Omnisend account. Use it when you need to ingest this data into Nexla, where the results are organized into one or more Nexsets.

[Rest API] List automation workflows with filtering and pagination

This endpoint template list automation workflows with filtering and pagination from your Omnisend account. Use it when you need to ingest this data into Nexla, where the results are organized into one or more Nexsets.

[Rest API] Retrieve a single workflow by ID

This endpoint template retrieve a single workflow by ID from your Omnisend account. Use it when you need to ingest this data into Nexla, where the results are organized into one or more Nexsets.

[Rest API] List email templates with pagination and filtering

This endpoint template list email templates with pagination and filtering from your Omnisend account. Use it when you need to ingest this data into Nexla, where the results are organized into one or more Nexsets.

[Rest API] Retrieve an email template by ID

This endpoint template retrieve an email template by ID from your Omnisend account. Use it when you need to ingest this data into Nexla, where the results are organized into one or more Nexsets.

[Rest API] List images with pagination and filtering

This endpoint template list images with pagination and filtering from your Omnisend account. Use it when you need to ingest this data into Nexla, where the results are organized into one or more Nexsets.

[Rest API] Retrieve an image by ID

This endpoint template retrieve an image by ID from your Omnisend account. Use it when you need to ingest this data into Nexla, where the results are organized into one or more Nexsets.

[Rest API] List products with pagination and filtering

This endpoint template list products with pagination and filtering from your Omnisend account. Use it when you need to ingest this data into Nexla, where the results are organized into one or more Nexsets.

[Rest API] Retrieve a product by ID

This endpoint template retrieve a product by ID from your Omnisend account. Use it when you need to ingest this data into Nexla, where the results are organized into one or more Nexsets.

[Rest API] List product categories

This endpoint template list product categories from your Omnisend account. Use it when you need to ingest this data into Nexla, where the results are organized into one or more Nexsets.

[Rest API] Retrieve a category by ID

This endpoint template retrieve a category by ID from your Omnisend account. Use it when you need to ingest this data into Nexla, where the results are organized into one or more Nexsets.

[Rest API] List segments with pagination and sorting

This endpoint template list segments with pagination and sorting from your Omnisend account. Use it when you need to ingest this data into Nexla, where the results are organized into one or more Nexsets.

[Rest API] Retrieve a segment by ID

This endpoint template retrieve a segment by ID from your Omnisend account. Use it when you need to ingest this data into Nexla, where the results are organized into one or more Nexsets.

[Rest API] Get segment statistics and contact count

This endpoint template get segment statistics and contact count from your Omnisend account. Use it when you need to ingest this data into Nexla, where the results are organized into one or more Nexsets.

[Rest API] Get batch list

This endpoint template get batch list from your Omnisend account. Use it when you need to ingest this data into Nexla, where the results are organized into one or more Nexsets.

[Rest API] Get batch information and status

This endpoint template get batch information and status from your Omnisend account. Use it when you need to ingest this data into Nexla, where the results are organized into one or more Nexsets.

[Rest API] Get batch item details

This endpoint template get batch item details from your Omnisend account. Use it when you need to ingest this data into Nexla, where the results are organized into one or more Nexsets.

[Rest API] Get current brand information

This endpoint template get current brand information from your Omnisend account. Use it when you need to ingest this data into Nexla, where the results are organized into one or more Nexsets.

[Rest API] Generate aggregated marketing analytics by send date

This endpoint template generate aggregated marketing analytics by send date from your Omnisend account. Use it when you need to ingest this data into Nexla, where the results are organized into one or more Nexsets.

[Rest API] Generate aggregated analytics by event date

This endpoint template generate aggregated analytics by event date from your Omnisend account. Use it when you need to ingest this data into Nexla, where the results are organized into one or more Nexsets.

Once the selected endpoint template has been configured, click the Test button to the right of the endpoint selection menu to retrieve a sample of the data that will be fetched. Sample data will be displayed in the Endpoint Test Result panel on the right, allowing you to verify that the source is configured correctly before saving.

Manual configuration

Omnisend data sources can also be manually configured to ingest data from any valid Omnisend REST API endpoint, including endpoints not covered by the pre-built templates, chained API calls, or custom request parameters. Select the Advanced tab at the top of the configuration screen, and follow the instructions in Connect to Any API to configure the API method, endpoint URL, date/time and lookup macros, path to data, metadata, and request headers.

Once all of the relevant settings have been configured, click the Create button in the upper right corner of the screen to save and create the new Omnisend data source. Nexla will now begin ingesting data from the configured endpoint and will organize any data that it finds into one or more Nexsets.

Use as a destination

Click the + icon on the Nexset that will be sent to the Omnisend destination, and select the Send to Destination option from the menu. Select the Omnisend connector from the list of available destination connectors, then select the credential that will be used to connect to Omnisend, and click Next; or, create a new Omnisend credential for use in this flow.

Endpoint templates

Nexla provides pre-built templates that can be used to rapidly configure destinations to send data to common Omnisend endpoints. Select the endpoint to which data will be sent from the Endpoint pulldown menu. Then, click on the template in the list below to expand it, and follow the instructions to configure additional endpoint settings.

[Rest API] Create or update a contact (upsert)

This endpoint template sends records from a Nexset to your Omnisend account to create or update a contact (upsert). Each record is sent to the Omnisend REST API as a separate request.

[Rest API] Update a contact by email

This endpoint template sends records from a Nexset to your Omnisend account to update a contact by email. Each record is sent to the Omnisend REST API as a separate request.

[Rest API] Update a contact by ID

This endpoint template sends records from a Nexset to your Omnisend account to update a contact by ID. Each record is sent to the Omnisend REST API as a separate request.

[Rest API] Add tags to multiple contacts

This endpoint template sends records from a Nexset to your Omnisend account to add tags to multiple contacts. Each record is sent to the Omnisend REST API as a separate request.

[Rest API] Remove tags from multiple contacts

This endpoint template sends records from a Nexset to your Omnisend account to remove tags from multiple contacts. Each record is sent to the Omnisend REST API as a separate request.

[Rest API] Create a campaign draft

This endpoint template sends records from a Nexset to your Omnisend account to create a campaign draft. Each record is sent to the Omnisend REST API as a separate request.

[Rest API] Update a campaign draft

This endpoint template sends records from a Nexset to your Omnisend account to update a campaign draft. Each record is sent to the Omnisend REST API as a separate request.

[Rest API] Delete a campaign

This endpoint template sends records from a Nexset to your Omnisend account to delete a campaign. Each record is sent to the Omnisend REST API as a separate request.

[Rest API] Submit campaign draft for sending

This endpoint template sends records from a Nexset to your Omnisend account to submit campaign draft for sending. Each record is sent to the Omnisend REST API as a separate request.

[Rest API] Cancel a scheduled or paused campaign

This endpoint template sends records from a Nexset to your Omnisend account to cancel a scheduled or paused campaign. Each record is sent to the Omnisend REST API as a separate request.

[Rest API] Create a new automation workflow

This endpoint template sends records from a Nexset to your Omnisend account to create a new automation workflow. Each record is sent to the Omnisend REST API as a separate request.

[Rest API] Partially update a workflow

This endpoint template sends records from a Nexset to your Omnisend account to partially update a workflow. Each record is sent to the Omnisend REST API as a separate request.

[Rest API] Delete a workflow

This endpoint template sends records from a Nexset to your Omnisend account to delete a workflow. Each record is sent to the Omnisend REST API as a separate request.

[Rest API] Enable workflow and process triggers

This endpoint template sends records from a Nexset to your Omnisend account to enable workflow and process triggers. Each record is sent to the Omnisend REST API as a separate request.

[Rest API] Disable workflow and stop new triggers

This endpoint template sends records from a Nexset to your Omnisend account to disable workflow and stop new triggers. Each record is sent to the Omnisend REST API as a separate request.

[Rest API] Create a new email template

This endpoint template sends records from a Nexset to your Omnisend account to create a new email template. Each record is sent to the Omnisend REST API as a separate request.

[Rest API] Replace an email template completely

This endpoint template sends records from a Nexset to your Omnisend account to replace an email template completely. Each record is sent to the Omnisend REST API as a separate request.

[Rest API] Delete an email template

This endpoint template sends records from a Nexset to your Omnisend account to delete an email template. Each record is sent to the Omnisend REST API as a separate request.

[Rest API] Send a customer event to trigger automations

This endpoint template sends records from a Nexset to your Omnisend account to send a customer event to trigger automations. Each record is sent to the Omnisend REST API as a separate request.

[Rest API] Upload an image from a publicly accessible URL

This endpoint template sends records from a Nexset to your Omnisend account to upload an image from a publicly accessible URL. Each record is sent to the Omnisend REST API as a separate request.

[Rest API] Upload an image file directly (max 5MB)

This endpoint template sends records from a Nexset to your Omnisend account to upload an image file directly (max 5MB). Each record is sent to the Omnisend REST API as a separate request.

[Rest API] Delete an image

This endpoint template sends records from a Nexset to your Omnisend account to delete an image. Each record is sent to the Omnisend REST API as a separate request.

[Rest API] Create a new product

This endpoint template sends records from a Nexset to your Omnisend account to create a new product. Each record is sent to the Omnisend REST API as a separate request.

[Rest API] Replace a product completely

This endpoint template sends records from a Nexset to your Omnisend account to replace a product completely. Each record is sent to the Omnisend REST API as a separate request.

[Rest API] Delete a product

This endpoint template sends records from a Nexset to your Omnisend account to delete a product. Each record is sent to the Omnisend REST API as a separate request.

[Rest API] Create a new product category

This endpoint template sends records from a Nexset to your Omnisend account to create a new product category. Each record is sent to the Omnisend REST API as a separate request.

[Rest API] Update a category

This endpoint template sends records from a Nexset to your Omnisend account to update a category. Each record is sent to the Omnisend REST API as a separate request.

[Rest API] Delete a category

This endpoint template sends records from a Nexset to your Omnisend account to delete a category. Each record is sent to the Omnisend REST API as a separate request.

[Rest API] Create a new segment

This endpoint template sends records from a Nexset to your Omnisend account to create a new segment. Each record is sent to the Omnisend REST API as a separate request.

[Rest API] Update a segment completely

This endpoint template sends records from a Nexset to your Omnisend account to update a segment completely. Each record is sent to the Omnisend REST API as a separate request.

[Rest API] Delete a segment (must not be building)

This endpoint template sends records from a Nexset to your Omnisend account to delete a segment (must not be building). Each record is sent to the Omnisend REST API as a separate request.

[Rest API] Create a batch for multiple operations

This endpoint template sends records from a Nexset to your Omnisend account to create a batch for multiple operations. Each record is sent to the Omnisend REST API as a separate request.

Manual configuration

Omnisend destinations can also be manually configured to send data to any valid Omnisend REST API endpoint. Select the Advanced tab at the top of the configuration screen, and follow the instructions in Connect to Any API to configure the API method, data format, endpoint URL, request headers, attribute exclusions, record batching, and response webhooks.

Omnisend APIs expect JSON format for most operations. For update, replace, and delete operations, the ID of the object being modified is included in the request URL.

Save & activate

Once all endpoint settings have been configured, click the Done button in the upper right corner of the screen to save and create the destination. To send the data to the configured Omnisend endpoint, open the destination resource menu, and select Activate.

The Nexset data will not be sent to the Omnisend endpoint until the destination is activated. Destinations can be activated immediately or at a later time, providing full control over data movement.