BigMailer Data Source

The BigMailer connector enables you to ingest brands, contacts, lists, segments, fields, message types, suppression lists, users, and campaign data from your BigMailer account. Follow the instructions below to create a new data flow that ingests data from a BigMailer source in Nexla.

BigMailer

Create a New Data Flow

1. To create a new data flow, navigate to the Integrate section, and click the New Data Flow button. Then, select the desired flow type from the list, and click the Create button.

2. Select the BigMailer connector tile from the list of available connectors. Then, select the credential that will be used to connect to the BigMailer instance, and click Next; or, create a new BigMailer credential for use in this flow.

3. In Nexla, BigMailer data sources can be created using pre-built endpoint templates, which expedite source setup for common BigMailer endpoints. Each template is designed specifically for the corresponding BigMailer endpoint, making source configuration easy and efficient.
   • To configure this source using a template, follow the instructions in Configure Using a Template.

   BigMailer sources can also be configured manually, allowing you to ingest data from BigMailer endpoints not included in the pre-built templates or apply further customizations to exactly suit your needs.
   • To configure this source manually, follow the instructions in Configure Manually.

Configure Using a Template

Nexla provides pre-built templates that can be used to rapidly configure data sources to ingest data from common BigMailer endpoints. Each template is designed specifically for the corresponding BigMailer endpoint, making data source setup easy and efficient.

Endpoint Settings

• 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. Click on an endpoint to see more information about it and how to configure your data source for this endpoint.

  List brands in your account

  Retrieves a paginated list of all brands associated with your BigMailer account. Use this endpoint to discover available brand IDs needed to configure other endpoints, or to maintain an inventory of brands managed under your account.

  • No additional parameters are required for this endpoint. Nexla automatically paginates through the full result set using the BigMailer offset and limit query parameters.
  • Records are extracted from the brands array in the response. Each record contains the brand ID, name, and configuration details.

  Brand IDs returned by this endpoint can be used as input for brand-scoped endpoints such as List Contacts, List Bulk Campaigns, and Get a list.

  Get Bulk Campaign

  Retrieves the full details for a single bulk campaign within a specified brand. Use this endpoint when you need the complete configuration, content, send statistics, and metadata for one specific campaign.

  • Enter the brand identifier in the Brand ID field. This is the ID of the brand that owns the campaign and can be obtained from the BigMailer console URL or from the List brands in your account endpoint.
  • Enter the campaign identifier in the Campaign ID field. This is the unique ID of the specific bulk campaign to retrieve; campaign IDs can be obtained from the List Bulk Campaigns endpoint or from the campaign detail page URL in the BigMailer console.

  Bulk campaigns in BigMailer are one-time email sends to a list or segment. For details on campaign fields and statuses, see the BigMailer Bulk Campaigns API documentation.

  List Bulk Campaigns

  Retrieves all bulk email campaigns for a specific brand. Use this endpoint to build campaign reporting flows, audit campaign activity, or sync campaign metadata to a downstream analytics destination.

  • Enter the brand identifier in the Brand ID field. Only campaigns belonging to the specified brand are returned.
  • Records are extracted from the campaigns array in the response. Nexla paginates automatically, fetching up to 50 campaigns per page and continuing until no more campaigns are returned.

  Combine this endpoint with the Get Bulk Campaign endpoint when you need detailed information for each campaign returned by the list call.

  List Transactional Campaigns

  Retrieves all transactional email campaigns for a specific brand. Transactional campaigns are reusable email templates triggered programmatically (for example, order confirmations or password resets); use this endpoint to inventory and report on transactional templates.

  • Enter the brand identifier in the Brand ID field. Only transactional campaigns for the specified brand are returned.
  • Records are extracted from the campaigns array in the response and paginated automatically.

  Transactional campaign IDs returned here are the values required by the Send Transactional Campaign Email destination endpoint.

  Get a contact by ID

  Retrieves the full record for a single contact in the specified brand, including custom field values, list memberships, and subscription status.

  • Enter the brand identifier in the Brand Id field.
  • Enter the contact identifier in the Contact Id field. Contact IDs can be obtained from the List Contacts endpoint or from the contact detail page URL in the BigMailer console.

  List Contacts

  Retrieves all contacts for a specific brand. Use this endpoint to sync your BigMailer contact database into a data warehouse, analytics platform, or CRM.

  • Enter the brand identifier in the Brand ID field.
  • Records are extracted from the contacts array in the response. Nexla paginates through results automatically using offset-based pagination at 50 records per page.

  For brands with very large contact databases, the initial sync may take several minutes to complete. Subsequent runs can be scheduled to capture incremental changes.

  List Contact Lists

  Retrieves all contact lists for a specific brand. Contact lists in BigMailer are explicit collections used to target campaigns; this endpoint returns list metadata such as name, description, and contact count.

  • Enter the brand identifier in the Brand ID field.
  • Records are extracted from the lists array and paginated automatically.

  List lists in a brand

  Returns a paginated list of all lists in the specified brand. This endpoint behaves identically to List Contact Lists and is provided for naming consistency with the BigMailer Lists API reference.

  • Enter the brand identifier in the Brand Id field.
  • Records are extracted from the lists array in the response.

  Get a list

  Retrieves the details for a single list in the specified brand, including list name, description, and contact count.

  • Enter the brand identifier in the Brand Id field.
  • Enter the list identifier in the List Id field. List IDs can be obtained from the List lists in a brand endpoint.

  List Segments

  Retrieves all segments configured for a specific brand. Segments are dynamic, rule-based subsets of contacts; this endpoint returns segment definitions and metadata.

  • Enter the brand identifier in the Brand ID field.
  • Records are extracted from the segments array in the response and paginated automatically.

  Segment definitions can be useful for documenting marketing logic or auditing audience-targeting rules across brands.

  List Suppression Lists

  Retrieves all suppression lists configured for a specific brand. Suppression lists hold email addresses that should never receive messages (for example, unsubscribes, bounces, or complaints).

  • Enter the brand identifier in the Brand ID field.
  • Records are extracted from the suppressionLists array in the response.

  Synchronizing suppression lists into a central database is a common compliance use case, helping ensure consistent unsubscribe handling across multiple sending platforms.

  List Contact Fields

  Retrieves all custom fields configured for a specific brand. Use this endpoint to discover the field schema before mapping contact attributes into or out of BigMailer.

  • Enter the brand identifier in the Brand ID field.
  • Records are extracted from the fields array in the response and include the field name, merge tag, and data type.

  List Message Types

  Retrieves all message types available for a specific brand. Message types categorize emails (for example, newsletter, product update, transactional) and are used by contacts to manage their subscription preferences.

  • Enter the brand identifier in the Brand ID field.
  • Records are extracted from the messageTypes array in the response.

  Get Current Account

  Retrieves the details of the account associated with the API key used in the credential. No additional parameters are required.

  • This endpoint is useful as a lightweight connectivity check or for capturing account-level metadata such as plan and limits.

  List Users

  Retrieves all users associated with your BigMailer account. Use this endpoint to inventory team members and their roles for access reviews or onboarding/offboarding workflows.

  • No additional parameters are required. Records are extracted from the users array in the response and paginated automatically.

  Get User

  Retrieves the details for a single user by ID.

  • Enter the user identifier in the User ID field. User IDs can be obtained from the List Users endpoint.

Endpoint Testing

Once the selected endpoint template has been configured, Nexla can retrieve a sample of the data that will be fetched according to the current settings. This allows users to verify that the source is configured correctly before saving.

• To test the current endpoint configuration, click the Test button to the right of the endpoint selection menu. Sample data will be fetched & displayed in the Endpoint Test Result panel on the right.

• If the sample data is not as expected, review the selected endpoint and associated settings, and make any necessary adjustments. Then, click the Test button again, and check the sample data to ensure that the correct information is displayed.

Configure Manually

BigMailer data sources can be manually configured to ingest data from any valid BigMailer API endpoint. Manual configuration provides maximum flexibility for accessing endpoints not covered by pre-built templates or when you need custom API configurations.

With manual configuration, you can also create more complex BigMailer sources, such as sources that use chained API calls to fetch data from multiple brand-scoped endpoints or sources that require custom headers and query parameters beyond the standard X-API-Key authentication header.

API Method

1. To manually configure this source, select the Advanced tab at the top of the configuration screen.

2. Select the API method that will be used for calls to the BigMailer API from the Method pulldown menu. The most common methods for source ingestion are:

   • GET: For retrieving data from the BigMailer API (used by all standard list and read endpoints)
   • POST: For endpoints that accept a request body to filter or query data

API Endpoint URL

3. Enter the URL of the BigMailer API endpoint from which this source will fetch data in the Set API URL field. All BigMailer endpoints are rooted at https://api.bigmailer.io/v1/. For brand-scoped endpoints, include the brand ID in the path—for example, https://api.bigmailer.io/v1/brands/{brand_id}/contacts.

Ensure the API endpoint URL is correct and accessible with your current credentials. You can test the endpoint using the Test button after configuring the URL.

Date/Time Macros (API URL)

Optional

Optionally, the API URL can be customized using macros—all macros added to the API URL will be converted into values when Nexla executes the API call. Macros are dynamic placeholders that allow you to create flexible API endpoints that can adapt to different time periods or data requirements.

Macros are particularly useful for BigMailer endpoints that accept date filters (such as filtering campaigns or contacts by creation or update date) where the value should advance with each scheduled run.

1. To add a macro, type { at the appropriate position in the API URL (within the Set API URL field), and select the desired macro from the dropdown list.

   • {now} – The current datetime
   • {now-1} – The datetime one time unit before the current datetime
   • {now+1} – The datetime one time unit after the current datetime
   • custom – Datetime macros can reference any number of time units before or after the current datetime—for example, enter (now-4) to indicate the datetime four time units before the current datetime

2. Select the format that will be applied to datetime macros from the Date Format for Date/Time Macro pulldown menu. This format will be applied to the base datetime value of the macro—i.e., the value of {now} in {now-1}.

3. Select the datetime unit that will be used to perform mathematical operations in the included macro(s) from the Time Unit for Operations pulldown menu—for example, for the macro {now-1}, when Day is selected, {now-1} will be converted to the datetime one day before the current datetime.

Lookup-Based Macros (API URL)

Optional

Column values from existing lookups can also be included as macros in the API URL. Lookup-based macros allow you to reference data from previously configured data sources or lookups, enabling dynamic API endpoints that can adapt based on existing data.

Lookup-based macros are particularly useful for BigMailer integrations where you need to iterate through brand IDs, list IDs, or campaign IDs sourced from another Nexla flow or lookup table.

1. To include a lookup column value macro, select the relevant lookup from the Add Lookups to Supported Macros pulldown menu.

2. Type { at the appropriate position in the API URL, and select the lookup column-based macro from the dropdown list. Lookup-based macros are automatically populated into the macro list when a lookup is selected in the Add Lookups to Supported Macros pulldown menu.

Path to Data

Optional

If only a subset of the data that will be returned by API endpoint is needed, you can designate the part(s) of the response that should be included in the Nexset(s) produced from this source by specifying the path to the relevant data within the response. This is particularly useful for BigMailer list endpoints, which return records inside a named array alongside pagination metadata.

For example, the GET /v1/brands/{brand_id}/contacts endpoint returns a response with a top-level contacts array along with pagination information. By entering the path $.contacts[*], you instruct Nexla to treat each contact as a record.

Path to Data is essential when API responses have nested structures. Without specifying the correct path, Nexla might not be able to properly parse and organize your data into usable records.

• To specify which data should be treated as relevant in responses from this source, enter the path to the relevant data in the Set Path to Data in Response field.

  • For responses in JSON format enter the JSON path that points to the object or array that should be treated as relevant data. JSON paths use dot notation (e.g., $.contacts[*] to access the contacts array returned by BigMailer list endpoints).
  Path to Data Example (BigMailer):

  For the BigMailer endpoint GET /v1/brands/{'{brand_id}'}/bulk-campaigns, the response is shaped as {'{ "campaigns": [...], "total": N }'}. To treat each campaign as a record, enter $.campaigns[*] in the path field.

Autogenerate Path Suggestions

Nexla can also autogenerate data path suggestions based on the response from the API endpoint. These suggested paths can be used as-is or modified to exactly suit your needs.

• To use this feature, click the Test button next to the Set API URL field to fetch a sample response from the API endpoint. Suggested data paths generated based on the content & format of the response will be displayed in the Suggestions box below the Set Path to Data in Response field.

• Click on a suggestion to automatically populate the Set Path to Data in Response field with the corresponding path. The populated path can be modified directly within the field if further customization is needed.

  

Metadata

If metadata is included in the response but is located outside of the defined path to relevant data, you can configure Nexla to include this data as common metadata in each record. This is useful when you want to preserve pagination details, total counts, or request context returned by BigMailer alongside the primary data array.

Metadata paths are particularly useful for preserving BigMailer pagination details (such as offset, limit, and total) so that audit trails and reporting flows can retain context about how each batch of data was retrieved.

• To specify the location of metadata that should be included with each record, enter the path to the relevant metadata in the Path to Metadata in Response field.

  • For responses in JSON format, enter the JSON path to the object or array that contains the metadata.

Request Headers

Optional

• If Nexla should include any additional request headers in API calls to this source, enter the headers & corresponding values as comma-separated pairs in the Request Headers field (e.g., Accept:application/json,Content-Type:application/json). The X-API-Key header used for BigMailer authentication is added automatically from the credential and does not need to be included here.

  You do not need to include the X-API-Key header here—it is supplied automatically by the credential. Common headers like Content-Type and Accept are typically handled automatically by Nexla.

Endpoint Testing

After configuring all settings for the selected endpoint, Nexla can retrieve a sample of the data that will be fetched according to the current configuration. This allows users to verify that the source is configured correctly before saving.

• To test the current endpoint configuration, click the Test button to the right of the endpoint selection menu. Sample data will be fetched & displayed in the Endpoint Test Result panel on the right.

• If the sample data is not as expected, review the selected endpoint and associated settings, and make any necessary adjustments. Then, click the Test button again, and check the sample data to ensure that the correct information is displayed.

Save & Activate the Source

1. Once all of the relevant steps in the above sections have been completed, click the Create button in the upper right corner of the screen to save and create the new BigMailer 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.