BigMailer is an email marketing platform built for agencies and makers, providing brand-based management of bulk, transactional, and automated campaigns with contact lists, segments, suppression lists, custom fields, and webhook-based event tracking.
Power end-to-end data operations for your BigMailer API with Nexla. Our bi-directional BigMailer connector is purpose-built for BigMailer, 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 BigMailer or any other destination. With comprehensive monitoring, lineage tracking, and access controls, Nexla keeps your BigMailer 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
BigMailer authenticates API requests using an API key passed in the X-API-Key request header. Before creating a BigMailer credential in Nexla, you must generate an API key from the BigMailer console.
Only Account Administrators and Account Managers can access the API key management page. If you do not have one of these roles, contact your BigMailer account administrator to obtain a key on your behalf or to have your role updated.
Navigate to the API key management page by clicking your account avatar in the upper-right corner of the console and selecting Account Settings, then choosing the API tab. The page is also directly accessible at https://app.bigmailer.io/console/accounts/api.
Click the Create Key button to open the new key dialog.
Enter a descriptive name for the key in the Name field. Choose a name that identifies the application or integration that will use this key (for example, Nexla Integration). This helps with auditing and key rotation later.
Click Create (or Save) to generate the key.
Copy the generated API key and store it in a secure location.
Important
The full API key is shown only once at the time of creation. Copy it immediately and store it securely—you will not be able to view the full key again from the BigMailer console. If the key is lost, you will need to create a new one.
After selecting the data source/destination type, click the Add Credential tile to open the Add New Credential overlay.
Enter a name for the credential in the Credential Name field and a short, meaningful description in the Credential Description field.
Paste the BigMailer API key generated above into the API Key field. Nexla stores this value securely and sends it in the X-API-Key header on every request to the BigMailer API.
Treat the API key like a password. Do not commit it to source control, share it in plain text, or paste it into shared documents. Rotate the key by creating a new one in the BigMailer console and updating the credential in Nexla if it may have been exposed.
Click the Save button at the bottom of the overlay. Nexla will validate the key by issuing a test request to the BigMailer GET /v1/me endpoint. The newly added credential will now appear in a tile on the Authenticate screen during data source/destination creation.
To create a new data flow, navigate to the Integrate section, and click the New Data Flow button. Select the BigMailer connector tile, 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.
Nexla provides pre-built templates that can be used to rapidly configure data sources to ingest data from common BigMailer 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.
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.
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.
BigMailer data sources can also be manually configured to ingest data from any valid BigMailer 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.
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. BigMailer list endpoints return records inside a named array alongside pagination metadata, so set the Path to Data to that array—for example, $.contacts[*] for contacts or $.campaigns[*] for bulk campaigns. The X-API-Key authentication header is added automatically from the credential and does not need to be included in the Request Headers field.
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 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.
Click the + icon on the Nexset that will be sent to the BigMailer destination, and select the Send to Destination option from the menu. Select the BigMailer connector from the list of available destination connectors, then select the credential that will be used to connect to the BigMailer organization, and click Next; or, create a new BigMailer credential for use in this flow.
Nexla provides pre-built templates that can be used to rapidly configure destinations to send data to common BigMailer 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.
Create a contact
Creates a new contact in the specified brand. Use this endpoint to ingest contacts into BigMailer from a source system such as a CRM, signup form, or contact import file.
Enter the brand identifier in the Brand Id field. This is the ID of the BigMailer brand that will own the new contacts.
Select a value for the Validate field. When set to true (recommended), BigMailer validates the contact's email address before creating the record and rejects invalid addresses. When set to false, addresses are stored as-is without validation.
Each Nexset record is sent as the JSON body of an individual POST request to /v1/brands/{'{brand_id}'}/contacts. Ensure the Nexset includes at minimum an email attribute; other supported attributes include list_ids, custom field merge tags, and subscription preferences.
Calling this endpoint with an email that already exists in the brand will return an error. Use the Create or update a contact endpoint when records may already exist and you want an upsert behavior.
Create or update a contact
Creates a new contact or updates an existing one based on email address. This is the recommended endpoint for synchronizing a contact source-of-truth (such as a CRM or warehouse) into BigMailer because it handles inserts and updates in a single call.
Enter the brand identifier in the Brand Id field.
Each Nexset record is sent as the JSON body of a PUT request to /v1/brands/{'{brand_id}'}/contacts. The record must include an email attribute; if a contact with that email already exists in the brand it is updated, otherwise a new contact is created.
Use this endpoint for ongoing synchronization flows where the same contact may appear repeatedly across runs. For one-time loads into an empty brand, the Create a contact endpoint is also acceptable.
Create a bulk campaign
Creates a new bulk campaign in the specified brand. Use this endpoint to programmatically create one-time email campaigns from another system (for example, generating a weekly digest based on data in your warehouse).
Enter the brand identifier in the Brand Id field.
Each Nexset record should contain the full bulk campaign definition—including name, subject, html/text content, from_name, from_email, and target list or segment IDs. Refer to the BigMailer Campaigns API documentation for the complete request schema.
Create Transactional Campaign
Creates a new transactional campaign (reusable transactional email template) for a brand. Transactional campaigns are referenced when sending one-off transactional emails such as password resets or order confirmations.
Enter the brand identifier in the Brand ID field.
Each Nexset record should contain the transactional campaign definition, including name, subject, content, and sender details as described in the BigMailer Transactional Campaigns API documentation.
Send Transactional Campaign Email
Sends an individual email using an existing transactional campaign template for a specific brand. This is the primary endpoint for sending transactional emails such as receipts, notifications, or password resets through BigMailer.
Enter the brand identifier in the Brand ID field.
Enter the transactional campaign identifier in the Campaign ID field. This is the ID of an existing transactional campaign (template) created via Create Transactional Campaign or the BigMailer console.
Each Nexset record represents one email send. The request body should include the recipient email address and any variables used by the campaign template to personalize the message.
Suppression lists are honored automatically—BigMailer will skip sending to addresses present in the brand's suppression lists. For high-volume use cases, monitor the response payload for delivery status and per-record errors.
Update Brand
Updates the settings and configuration of an existing brand. Use this endpoint to programmatically modify brand attributes such as the display name, contact details, branding, or default sending behavior.
Enter the identifier of the brand to update in the Brand ID field.
Each Nexset record should contain the brand fields to update, in the structure defined by the BigMailer Brands API documentation.
Delete a list
Deletes a list from the specified brand. Contacts that belonged to the list are not affected—only the list itself and its membership associations are removed.
Enter the brand identifier in the Brand Id field.
Enter the list identifier in the List Id field. The request body for this endpoint is empty—list selection is driven by the path parameters.
Deleting a list is irreversible. Confirm the correct List Id before activating a flow that targets this endpoint.
Delete Sender
Deletes a sender from a brand. Senders represent verified "from" identities used by campaigns; removing a sender prevents it from being used in future campaigns.
Enter the brand identifier in the Brand ID field.
Enter the sender identifier in the Sender ID field. The request body is empty.
BigMailer destinations can also be manually configured to send data to any valid BigMailer 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.
BigMailer expects application/json request bodies, and all endpoints are rooted at https://api.bigmailer.io/v1/. For update/upsert operations that target a specific resource (such as Update Brand), include the resource ID at the end of the URL—for example, https://api.bigmailer.io/v1/brands/{brand_id}. The X-API-Key header is supplied automatically by the credential. You can also enable the response-webhook option to send the BigMailer API response after each call to a new Nexla webhook data source, which is useful for capturing send IDs, validation results, and per-record errors returned by BigMailer.
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 begin sending data to BigMailer, open the destination resource menu, and select Activate.
The Nexset data will not be sent to BigMailer until the destination is activated. Destinations can be activated immediately or at a later time, providing full control over data movement.
