Skip to main content

BigMailer Destination

Nexla's bi-directional connectors allow data to flow both to and from any location, making it simple to create a FlexFlow data flow that sends data to a BigMailer location.
big_mailer_api.png

BigMailer

Create a BigMailer Destination​

  1. Click the + icon on the Nexset that will be sent to the BigMailer destination, and select the Send to Destination option from the menu.

  2. 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.

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

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

Configure Using a Template​

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

  • To configure this destination using a template, 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.

Configure Manually​

BigMailer destinations can be manually configured to send data to any valid BigMailer API endpoint.

Using manual configuration, you can also configure Nexla to automatically send the response received from the BigMailer API 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.

API Method​

  1. To manually configure this destination, 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 destination flows are:

    • POST: For creating new resources (contacts, campaigns, sends)
    • PUT: For upsert-style operations (Create or update a contact, Update Brand)
    • DELETE: For removing resources (Delete a list, Delete Sender)
    • PATCH: For partial updates supported by the BigMailer API

Data Format​

  1. Select the format in which the Nexset data will be sent to the BigMailer API from the Content Format pulldown menu. BigMailer expects application/json for all request bodies, so JSON is the appropriate choice for most flows. Nexla will automatically convert the data to JSON for each API call.

API Endpoint URL​

  1. Enter the URL of the BigMailer API endpoint to which you want to send the Nexset data in the URL field. All BigMailer endpoints are rooted at https://api.bigmailer.io/v1/. For update/upsert operations that operate on 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}.

Request Headers​

Optional

  • If Nexla should include any additional request headers in API calls to this destination, enter the headers & corresponding values as comma-separated pairs in the Request Headers field (e.g., Accept:application/json,Content-Type:application/json).

    You do not need to include the X-API-Key header here—it is supplied automatically by the credential.

Exclude Attributes from the Call​

Optional

  • If any record attributes in the Nexset should be omitted when sending data to this BigMailer destination, select the attributes from the Exclude Attributes pulldown menu. This is commonly used to drop internal staging fields or PII that should not be persisted in BigMailer.

  • Any number of attributes can be selected for exclusion, and all excluded attributes will be shown in the field. To remove an attribute from the list, click the X icon next to the attribute name.

Record Batching​

Optional

  1. If records should be sent to this destination in batched API calls, check the box next to Would you like to batch your records together? to enable record batching. The BigMailer endpoint templates listed above all use per-record API calls (one HTTP request per record), so batching is generally only relevant when targeting a custom BigMailer endpoint that supports an array body.

  2. Enter the maximum number of records that should be batched together in a single API call in the Batch Size field. By default, this value is set to 100.

  3. Select the algorithm that will be used to group records into batches from the Grouping Algorithm pulldown menu. The sample request shown in the panel on the right will be updated to reflect the current batching settings. Some algorithms require additional settings—click on an algorithm listed below to view instructions for configuring these settings.

Response Webhook​

Optional

Nexla can automatically send the response received from the BigMailer API after each call to a new Nexla webhook data source. This option allows you to keep track of the status of each API call and capture additional information returned by BigMailer, such as newly created contact or campaign IDs, validation errors, and per-record send status.

  • To enable this option, check the box next to Would you like to process the API response as a Nexla Webhook source?.

Sample Request Payload​

Sample request payloads containing a portion of the Nexset data that will be sent to the BigMailer API endpoint based on the current settings are shown in the Sample Payload panel on the right. These samples can be referenced to ensure that the destination and request settings are correctly configured.

  • Click on a sample request payload to expand it and view the complete payload content.
  • Sample payloads are automatically updated with each setting change, making it easy to verify that changes achieve the desired effect.

Endpoint Testing (Manual Configuration)​

After all endpoint settings have been configured, Nexla can send a test payload to the BigMailer API to ensure that the destination is configured correctly.

  1. To send a test payload, select the Test button at the top of the Sample Payload panel, and click on a listed sample payload to expand it.

  2. If any modifications to the sample payload are needed, make the necessary changes directly within the sample window.

  3. Click the Send Test Data button at the top of a sample payload to send the test payload to the BigMailer API using the current settings.

Save & Activate the Destination​

  • 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.