Skip to main content

Flexmail 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 Flexmail location.
flexmail_api.png

Flexmail

Create a Flexmail Destination​

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

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

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

    Flexmail destinations can also be configured manually, allowing you to send data to Flexmail 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 Flexmail endpoints. Each template is designed specifically for the corresponding Flexmail 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 or update a contact

    This endpoint creates a new contact or updates an existing contact in Flexmail, identified by their email address. Use this endpoint to synchronize contact data from external systems into Flexmail, keeping your contact database current.

    • This endpoint requires no additional path parameters. Nexla will send the Nexset record data as a JSON request body to https://api.flexmail.eu/contacts using the POST method.

    • Ensure the Nexset data includes at minimum an email address field, which Flexmail uses to identify whether to create a new contact or update an existing one. Additional fields may include:

      • first_name and last_name: The contact's name.
      • language: The preferred language of the contact (e.g., nl, fr, en).
      • custom fields: Any custom contact fields defined in your Flexmail account.

    For the full list of supported contact fields and data types, refer to the Flexmail Contacts API documentation.

    Update a contact

    This endpoint updates specific fields of an existing Flexmail contact by their unique contact ID. Use this endpoint when you need to update contact attributes for known contacts without creating new records.

    • Enter the unique numeric identifier of the contact to be updated in the Id field. This is a path parameter that will be included in the request URL.
    • Nexla will send only the fields included in the Nexset record as a JSON PATCH request body. Only the fields provided will be updated; other contact fields will remain unchanged.

    For the full list of updatable contact fields, refer to the Flexmail Contacts API documentation.

    Delete a contact

    This endpoint permanently deletes a Flexmail contact by their unique contact ID. Use this endpoint when you need to remove contacts from Flexmail, for example as part of a data cleanup or compliance (right-to-erasure) workflow.

    • Enter the unique numeric identifier of the contact to be deleted in the Id field. This is a path parameter included in the request URL.
    • No request body is sent for DELETE operations.

    :::warning Important Deleting a contact is a permanent action and cannot be undone. Ensure that the correct contact ID is provided before activating this destination. :::

    Subscribe contact to interest

    This endpoint subscribes a specific Flexmail contact to an interest area (topic group or mailing list). Use this endpoint to automatically assign contact interest subscriptions based on data from external systems, such as a CRM or website form submission.

    • Enter the unique numeric identifier of the contact in the Id field. This is a path parameter included in the request URL.

    • Ensure the Nexset data includes the interest ID to subscribe the contact to. The request body should include:

      • interest_id: The numeric ID of the interest the contact should be subscribed to. Interest IDs can be found in your Flexmail account under the interests management section.

    For additional details on Flexmail interests and interest subscriptions, refer to the Flexmail Contacts API documentation.

    Unsubscribe contact from interest

    This endpoint removes a Flexmail contact's subscription from a specific interest area. Use this endpoint to update interest preferences when a contact's opt-out or preference changes are captured in an external system.

    • Enter the unique numeric identifier of the contact in the Id field. This is the first path parameter included in the request URL.
    • Enter the unique numeric identifier of the interest from which the contact should be unsubscribed in the Interest Id field. This is the second path parameter in the request URL.
    • No request body is sent for this DELETE operation.

    For additional details on Flexmail interest subscriptions, refer to the Flexmail Contacts API documentation.

    Unsubscribe Contact

    This endpoint unsubscribes a Flexmail contact from all mailings by their unique contact ID. Use this endpoint to process global unsubscribe requests received from external sources, ensuring the contact is no longer included in any Flexmail campaigns.

    • Enter the unique numeric identifier of the contact to unsubscribe in the Id field. This is a path parameter included in the request URL.
    • No request body is required for this operation.

    :::warning Important Unsubscribing a contact from all mailings is a significant action. The contact will no longer receive any email campaigns from your Flexmail account until they re-subscribe. :::

    Create Webhook

    This endpoint registers a new webhook endpoint in Flexmail to receive event notifications. Use this endpoint to programmatically configure Flexmail to send event data (such as contact subscriptions, unsubscribes, or campaign interactions) to an external URL.

    • This endpoint requires no additional path parameters. Nexla will send the Nexset record data as a JSON request body to https://api.flexmail.eu/webhooks.

    • Ensure the Nexset data includes the required fields for registering a webhook, which typically include:

      • url: The target URL that will receive the webhook notifications.
      • events: An array of event type names that should trigger the webhook. Use the List Webhook Events source endpoint to discover available event types.

    For additional details on Flexmail webhook registration, refer to the Flexmail Webhooks API documentation.

    Delete Webhook

    This endpoint deletes an existing Flexmail webhook subscription by its unique webhook ID. Use this endpoint to programmatically remove webhook registrations that are no longer needed.

    • Enter the unique numeric identifier of the webhook to be deleted in the Id field. This is a path parameter included in the request URL.
    • No request body is sent for this DELETE operation.

    For additional details on Flexmail webhook management, refer to the Flexmail Webhooks API documentation.

    Create a new email campaign

    This endpoint creates a new email campaign in Flexmail. Use this endpoint to programmatically create campaigns based on data-driven inputs, such as generating personalized campaigns from a CRM or automation system.

    • This endpoint requires no additional path parameters. Nexla will send the Nexset record data as a JSON request body to https://api.flexmail.eu/campaigns.
    • Ensure the Nexset data includes the required fields for campaign creation, such as the campaign name, subject, sender details, and content configuration, as specified in the Flexmail API documentation.

    For the full list of required and optional campaign fields, refer to the Flexmail API documentation.

    Send or schedule an existing campaign

    This endpoint triggers the sending or scheduling of an existing Flexmail campaign by its campaign ID. Use this endpoint to programmatically dispatch campaigns at a specific time or immediately after they are created.

    • Enter the unique numeric identifier of the campaign to send in the Id field (Campaign ID). This parameter is required.

    • Ensure the Nexset data includes the required fields for sending the campaign. Depending on your Flexmail configuration, this may include:

      • scheduled_at: The date and time to schedule the campaign (ISO 8601 format). If omitted, the campaign may be sent immediately.
      • segments or interests: The target audience identifiers for the campaign.

    For the full list of send parameters, refer to the Flexmail API documentation.

    Update an existing campaign

    This endpoint updates the content, subject line, or settings of an existing Flexmail campaign by its campaign ID. Use this endpoint when you need to make programmatic changes to campaigns before they are sent.

    • Enter the unique numeric identifier of the campaign to update in the Id field (Campaign ID). This parameter is required.
    • Nexla will send only the fields included in the Nexset record as a JSON PATCH request body. Only the provided fields will be updated; all other campaign settings will remain unchanged.

    For the full list of updatable campaign fields, refer to the Flexmail API documentation.

    Delete a campaign

    This endpoint permanently deletes a Flexmail campaign by its unique campaign ID. Use this endpoint to remove campaigns that are no longer needed or were created in error.

    • Enter the unique numeric identifier of the campaign to delete in the Id field (Campaign ID). This parameter is required.
    • No request body is required for this DELETE operation.

    :::warning Important Deleting a campaign is a permanent action and cannot be undone. Ensure that the correct campaign ID is provided before activating this destination. :::

    Send a test campaign

    This endpoint sends a test or preview version of a Flexmail campaign to a specified test email address. Use this endpoint to validate campaign content and rendering before sending to the full audience.

    • Enter the unique numeric identifier of the campaign to test in the Id field (Campaign ID). This parameter is required.
    • Ensure the Nexset data includes the test recipient email address or addresses in the request body, as required by the Flexmail API.

    For additional details on sending test campaigns, refer to the Flexmail API documentation.

    Create a new contact segment

    This endpoint creates a new contact segment in Flexmail. Segments are filters on your contact database that define a specific group of contacts based on criteria such as interests, language, or campaign behavior. Use this endpoint to programmatically create segments based on external data logic.

    • This endpoint requires no additional path parameters. Nexla will send the Nexset record data as a JSON request body to https://api.flexmail.eu/segments.
    • Ensure the Nexset data includes the required fields for segment creation, such as the segment name and any filter criteria, as specified in the Flexmail API documentation.

    For the full list of required and optional segment fields, refer to the Flexmail Segments API documentation.

    Update an existing segment

    This endpoint updates the criteria or name of an existing Flexmail segment by its unique segment ID. Use this endpoint to programmatically modify segment definitions based on updated business rules or data criteria.

    • Enter the unique numeric identifier of the segment to update in the Id field (Segment ID). This parameter is required.
    • Nexla will send only the fields included in the Nexset record as a JSON PATCH request body. Only the provided fields will be updated; all other segment settings will remain unchanged.

    For the full list of updatable segment fields, refer to the Flexmail Segments API documentation.

    Delete a segment

    This endpoint permanently deletes a Flexmail segment by its unique segment ID. Use this endpoint to remove segments that are no longer needed as part of a data management or cleanup workflow.

    • Enter the unique numeric identifier of the segment to delete in the Id field (Segment ID). This parameter is required.
    • No request body is required for this DELETE operation.

    :::warning Important Deleting a segment is a permanent action and cannot be undone. Ensure that the correct segment ID is provided before activating this destination. :::

    Create a new interest

    This endpoint creates a new interest (mailing list or topic group) in Flexmail. Interests allow contacts to self-select their preferences, helping marketers segment audiences based on stated interests. Use this endpoint to programmatically create new interest categories.

    • This endpoint requires no additional path parameters. Nexla will send the Nexset record data as a JSON request body to https://api.flexmail.eu/interests.
    • Ensure the Nexset data includes the required fields for interest creation, such as the interest name, as specified in the Flexmail API documentation.

    For additional details on Flexmail interests, refer to the Flexmail Interests API documentation.

    Update an existing interest

    This endpoint updates an existing Flexmail interest by its unique interest ID. Use this endpoint to programmatically rename or modify interest definitions in your Flexmail account.

    • Enter the unique numeric identifier of the interest to update in the Id field (Interest ID). This parameter is required.
    • Nexla will send only the fields included in the Nexset record as a JSON PATCH request body. Only the provided fields will be updated; all other interest settings will remain unchanged.

    For additional details on Flexmail interests, refer to the Flexmail Interests API documentation.

    Delete an interest

    This endpoint permanently deletes a Flexmail interest by its unique interest ID. Use this endpoint to remove interest categories that are no longer needed.

    • Enter the unique numeric identifier of the interest to delete in the Id field (Interest ID). This parameter is required.
    • No request body is required for this DELETE operation.

    :::warning Important Deleting an interest is a permanent action and cannot be undone. Contacts subscribed to this interest will lose their subscription when the interest is deleted. :::

    Create a new custom contact field

    This endpoint creates a new custom contact field definition in Flexmail. Custom fields allow you to store additional contact attributes beyond the standard fields provided by Flexmail. Use this endpoint to programmatically extend your Flexmail contact schema based on external data requirements.

    • This endpoint requires no additional path parameters. Nexla will send the Nexset record data as a JSON request body to https://api.flexmail.eu/custom-fields.
    • Ensure the Nexset data includes the required fields for custom field creation, such as the field name and data type, as specified in the Flexmail API documentation.

    For additional details on Flexmail custom fields, refer to the Flexmail Custom Fields API documentation.

    Update an existing custom field

    This endpoint updates an existing custom contact field definition in Flexmail by its unique field ID. Use this endpoint to programmatically rename or modify custom field definitions in your Flexmail account.

    • Enter the unique numeric identifier of the custom field to update in the Id field (Custom field ID). This parameter is required.
    • Nexla will send only the fields included in the Nexset record as a JSON PATCH request body. Only the provided fields will be updated.

    For additional details on Flexmail custom fields, refer to the Flexmail Custom Fields API documentation.

    Delete a custom contact field

    This endpoint permanently deletes a custom contact field definition from Flexmail by its unique field ID. Use this endpoint to remove custom fields that are no longer needed.

    • Enter the unique numeric identifier of the custom field to delete in the Id field (Custom field ID). This parameter is required.
    • No request body is required for this DELETE operation.

    :::warning Important Deleting a custom field is a permanent action and cannot be undone. All contact data stored in this field will also be removed. :::

Configure Manually​

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

Using manual configuration, you can also configure Nexla to automatically send the response received from the Flexmail API after each call to a new Nexla webhook data source.

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 Flexmail API from the Method pulldown menu. The most common methods for Flexmail destination operations are:

    • POST: For creating new contacts, campaigns, interests, webhooks, or other resources
    • PATCH: For partial updates to existing contacts, campaigns, or segments
    • DELETE: For removing contacts, webhooks, campaigns, or other resources
    • PUT: For full updates to existing resources

Data Format​

  1. Select the format in which the Nexset data will be sent to the Flexmail API from the Content Format pulldown menu. The Flexmail REST API accepts data in JSON format (application/json). Nexla will automatically convert the data to the selected format for each API call.

API Endpoint URL​

  1. Enter the URL of the Flexmail API endpoint to which you want to send the Nexset data in the URL field. This should be the complete URL including the protocol (https://) and any required path parameters. For update or delete operations, include the ID of the object to be modified at the end of the URL.

All Flexmail REST API endpoints are hosted at https://api.flexmail.eu/. For a complete list of available endpoints and their URL patterns, refer to the Flexmail API documentation.

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., header1:value1,header2:value2).

    You do not need to include the Authorization header or any other headers already present in the Flexmail credential. These are handled automatically by Nexla based on your credential configuration.

Exclude Attributes from the Call​

Optional

  • If any record attributes in the Nexset should be omitted when sending data to this Flexmail destination, select the attributes from the Exclude Attributes pulldown menu.

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

  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 Flexmail 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 any additional information returned after each call.

  • 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 Flexmail 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 Flexmail 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 Flexmail 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 send the data to the configured Flexmail endpoint, open the destination resource menu, and select Activate.

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