Skip to content
  • Documentation >
  • Apps >
  • Marketing >
  • BigMarker

BigMailer

With BigMailer modules in Ibexa Connect, you can:

  • watch, create, update, retrieve, list, and delete contacts

  • send transactional emails in transactional campaigns

To get started with BigMailer, create an account at bigmailer.io.

Connect BigMailer to Ibexa Connect

To connect to BigMailer app, you need to retrieve the API key from your BigMailer account:

  1. Log in to your BigMailer account.

  2. Click Account > API.

    BigMailer_2.png

  3. Click Create Key.

    BigMailer_3.png

  4. Enter a name for the key, select the required permissions, and click Create.

    BigMailer_4.png

  5. Copy the API Key to a safe place.

    BigMailer_5.png

  6. Log in to your Ibexa Connect account, add a BigMailer module and click the Add button next to the Connection field.

    BigMailer_1.gif

  7. In the Connection name field, enter a name for the connection.

  8. In the API Key fields, enter the details copied in step 5 and click Save.

You have successfully connected the BigMailer app and can now build scenarios.

Contacts

You can watch, create, update, retrieve, list, and delete contacts using the following modules.

Watch New Contacts

Triggers when a new contact is created.
Brand ID Select or map the Brand ID whose new contacts you want to watch.
Limit Set the maximum number of contacts Ibexa Connect will return during one execution cycle.

Create a Contact

Creates a contact.

For field descriptions, see the BigMailer API reference.

Update a Contact

Updates a contact. Any parameters not provided are left unchanged.
Brand ID Select or map the Brand ID whose contact details you want to update.
Contact ID Select or map the Contact ID whose details you want to update.

For field descriptions, see the BigMailer API reference.

Get a Contact

Gets a contact.
Brand ID Select or map the Brand ID whose contact details you want to retrieve.
Contact ID Select or map the Contact ID whose details you want to retrieve.

List Contacts

Gets all contacts from the brand.
Brand ID Select or map the Brand ID whose contacts you want to list.
Limit Set the maximum number of contacts Ibexa Connect will return during one execution cycle.

Delete a Contact

Deletes a contact.
Brand ID Select or map the Brand ID whose contact you want to delete.
Contact ID Select or map the Contact ID you want to delete.

Transactional Campaigns

You can send transactional emails using the following module.

Send a Transactional Email

Sends an email as part of a transactional campaign.

For field descriptions, see the BigMailer API reference

Other

You can call APIs using the following module.

Make an API Call

Performs an arbitrary authorized API call.

URL

Enter a path relative to https://api.bigmailer.io. For example: /v1/brands.

Method

GET

to retrieve information for an entry.

POST

to create a new entry.

PUT

to update/replace an existing entry.

PATCH

to make a partial entry update.

DELETE

to delete an entry.

Headers

Enter the desired request headers. You don't have to add authorization headers; we already did that for you.

Query String

Enter the request query string.

Body

Enter the body content for your API call.

Example of use - List Contacts

The following API call returns all contacts from your BigMailer account.

**URL: ** /v1/brands/{brand_id}/contacts

Method: GET

BigMailer_6.png

Matches of the search can be found in the module's Output under Bundle > Body > data.

In our example 10 contacts were returned:

BigMailer_7.png