Skip to main content

Overview

To authenticate with BigMailer, you need:
  1. API Key — a BigMailer API key.
This guide will show you how to create it.

Prerequisites

  • A BigMailer account. You can sign up for free on the Startup plan.
  • An activated account: click the activation link in the email BigMailer sends after signup. Until then, you cannot create API keys.
  • The Account Administrator role. The account owner has it by default.

Step 1: Create an API key

  1. Sign in to the BigMailer console.
  2. Open Account -> API (API key management page) and click Create Key.
BigMailer API tab with the Create Key button highlighted
  1. Enter a Name that tells you which application uses the key.
  2. Under Brands and Actions, limit the key to what your integration needs (for example brands/list and brands/get), then click Create.
BigMailer Create API Key dialog with a name, All Brands, and the brands/list and brands/get actions selected, and the Create button highlighted
  1. Click Copy to clipboard to copy the API key, then click OK.
BigMailer dialog showing the new API key with the Copy to clipboard button highlighted

Step 2: Enter your API key in the Connect UI

  1. Open the form where you need to authenticate with BigMailer.
  2. Enter your API Key in the designated field.
  3. Click Connect.
Nango Connect UI form for entering the BigMailer API Key You are now connected to BigMailer.