Campaigner

Campaigner is a comprehensive email marketing platform that provides businesses with essential and advanced email marketing features, enabling effective campaign creation, automation, segmentation, and analytics to drive customer engagement and business growth.

Power end-to-end data operations for your Campaigner API with Nexla. Our bi-directional Campaigner connector is purpose-built for Campaigner, 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 Campaigner or any other destination. With comprehensive monitoring, lineage tracking, and access controls, Nexla keeps your Campaigner 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 a Campaigner credential, you need to obtain an API key from your Campaigner account. The API key is required to authenticate with the Campaigner REST API.

To obtain your API key, you need to have a Campaigner account with API access enabled. Once you have access to your account, you can generate an API key from your account settings. The API key is used to authenticate all API requests to the Campaigner REST API using the ApiKey header. For detailed information about API key setup and authentication, refer to the Campaigner REST API documentation.

Authenticate

Credentials required

Field	Required	Secret	Description
API Key Value	Yes	Yes	The API key obtained from your Campaigner account settings, sent in the ApiKey header to authenticate all API requests to the Campaigner REST API.

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.

New Credential Overlay – Campaigner

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 Campaigner API key in the API Key Value field. This is the API key you obtained from your Campaigner account settings. The API key is sent in the ApiKey header to authenticate all API requests to the Campaigner REST API.

   Keep your API key secure and do not share it publicly. The API key provides access to your Campaigner account and should be treated as a sensitive credential.

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 Campaigner connector tile, then select the credential that will be used to connect to the Campaigner instance, and click Next; or, create a new Campaigner 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 Campaigner 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.

Get Sources

This endpoint retrieves a list of Source objects from your Campaigner account. Use this endpoint when you need to access source information for data import, contact management, or source analysis.

• This endpoint automatically retrieves all sources from your Campaigner account. No additional configuration is required beyond selecting this endpoint template.
• The endpoint uses GET requests to https://edapi.campaigner.com/v1/Sources. The endpoint URL is automatically constructed based on the Campaigner API base URL.
• The endpoint does not use pagination and returns all sources in a single request.
• The endpoint will return all sources in your account. The response data is extracted from the Sources array in the API response ($.Sources[*]), with each source record processed individually.

The endpoint uses a static URL (iteration.type: static.url) and does not require pagination. The response data path is $.Sources[*], which extracts all items from the Sources array in the API response. For detailed information about retrieving sources, see the Campaigner API documentation.

All Campaigns

This endpoint allows you to page through all campaigns regardless of their status, including deleted campaigns. Use this endpoint when you need to access comprehensive campaign information for analysis, reporting, or campaign management.

• This endpoint automatically retrieves all campaigns from your Campaigner account, including deleted campaigns. No additional configuration is required beyond selecting this endpoint template.
• The endpoint uses GET requests to https://edapi.campaigner.com/v1/Campaigns/All. The endpoint URL is automatically constructed based on the Campaigner API base URL.
• The endpoint uses incrementing page-based pagination, automatically fetching additional pages as needed using the PageNumber and PageSize query parameters. The endpoint starts from page 1 and continues fetching pages until all available campaigns have been retrieved. By default, the endpoint retrieves up to 100 items per page.
• The endpoint will return all campaigns in your account, including deleted campaigns. The response data is extracted from the Items array in the API response ($.Items[*]), with each campaign record processed individually.

This endpoint supports pagination through PageNumber and PageSize query parameters. Nexla automatically handles pagination to retrieve all available records by incrementing the page number until no more data is returned. The endpoint uses incrementing page-based pagination (iteration.type: paging.incrementing), starting from page 1. By default, the endpoint retrieves up to 100 items per page (page.expected.rows: 100). The response data path is $.Items[*], which extracts all items from the Items array in the API response. This endpoint includes all campaigns regardless of status, including deleted campaigns. For detailed information about retrieving campaigns, see the Campaigner API documentation.

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

Campaigner data sources can also be manually configured to ingest data from any valid Campaigner 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, path to data, and request headers.

Campaigner API endpoints typically follow the pattern https://edapi.campaigner.com/v1/{endpoint_path} and require API key authentication in the ApiKey header, which is handled automatically by your credential configuration. Paths to data are case-sensitive and vary by endpoint — for example, $.Sources[*] extracts all items from the Sources array, while $.Items[*] extracts all items from the Items array.

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 Campaigner 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 Campaigner destination, and select the Send to Destination option from the menu. Select the Campaigner connector from the list of available destination connectors, then select the credential that will be used to connect to the Campaigner organization, and click Next; or, create a new Campaigner 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 Campaigner 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.

Add Campaign

This endpoint creates a new campaign in your Campaigner account. The endpoint expects a campaign object. Use this endpoint when you need to create email marketing campaigns from your data sources.

• The endpoint uses POST requests to https://edapi.campaigner.com/v1/Campaigns. The endpoint URL is automatically constructed based on the Campaigner API base URL.
• The endpoint sends data from your Nexset as the request body in JSON format. Each record in your Nexset will be sent as a JSON object containing the campaign data to create. The request body should follow the Campaigner API specification for creating campaigns, including required fields and field names.
• Batch mode is disabled by default for this endpoint. Each record in your Nexset will be sent as a separate API request to create a campaign. If you need to create multiple campaigns, you can send multiple records, but each will be processed as a separate request.

The request body must be properly formatted JSON that matches the Campaigner API specification for creating campaigns. The endpoint requires API key authentication in the ApiKey header, which is handled automatically by your credential configuration. The Content-Type: application/json header is automatically included in requests. Batch mode is disabled by default (batch.mode: false), so each record will be sent as a separate request. For detailed information about creating campaigns, including required fields, field names, and request formats, see the Campaigner API documentation.

Add List

This endpoint adds a new list to your Campaigner account. Use this endpoint when you need to create contact lists from your data sources, such as importing subscriber lists or creating segmented lists.

• The endpoint uses POST requests to https://edapi.campaigner.com/v1/Lists. The endpoint URL is automatically constructed based on the Campaigner API base URL.
• The endpoint sends data from your Nexset as the request body in JSON format. Each record in your Nexset will be sent as a JSON object containing the list data to create. The request body should follow the Campaigner API specification for creating lists, including required fields and field names.
• Batch mode is disabled by default for this endpoint. Each record in your Nexset will be sent as a separate API request to create a list. If you need to create multiple lists, you can send multiple records, but each will be processed as a separate request.

The request body must be properly formatted JSON that matches the Campaigner API specification for creating lists. The endpoint requires API key authentication in the ApiKey header, which is handled automatically by your credential configuration. The Content-Type: application/json header is automatically included in requests. Batch mode is disabled by default (batch.mode: false), so each record will be sent as a separate request. For detailed information about creating lists, including required fields, field names, and request formats, see the Campaigner API documentation.

Manual configuration

Campaigner destinations can also be manually configured to send data to any valid Campaigner REST API endpoint, including endpoints not covered by the pre-built templates or those requiring custom API configurations. 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, and request headers.

Campaigner API endpoints typically follow the pattern https://edapi.campaigner.com/v1/{endpoint_path} and primarily use POST requests with JSON request bodies. The endpoint requires API key authentication in the ApiKey header, and the Content-Type: application/json header is included automatically — you do not need to add headers already present in your credential configuration.

Save & activate

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

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