BigMailer

The BigMailer Developer Hub

Welcome to the BigMailer developer hub. You'll find comprehensive guides and documentation to help you start working with BigMailer as quickly as possible, as well as support if you get stuck. Let's jump right in!

Get Started    
 
Suggest Edits

Create contact

Create a contact

 

Header Auth

 Authentication is required for this endpoint.
posthttps://api.bigmailer.io/v1/contacts
curl --request POST \
  --url https://api.bigmailer.io/v1/contacts
var request = require("request");

var options = { method: 'POST', url: 'https://api.bigmailer.io/v1/contacts' };

request(options, function (error, response, body) {
  if (error) throw new Error(error);

  console.log(body);
});
require 'uri'
require 'net/http'

url = URI("https://api.bigmailer.io/v1/contacts")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Post.new(url)

response = http.request(request)
puts response.read_body
var data = JSON.stringify(false);

var xhr = new XMLHttpRequest();
xhr.withCredentials = true;

xhr.addEventListener("readystatechange", function () {
  if (this.readyState === this.DONE) {
    console.log(this.responseText);
  }
});

xhr.open("POST", "https://api.bigmailer.io/v1/contacts");

xhr.send(data);
import requests

url = "https://api.bigmailer.io/v1/contacts"

response = requests.request("POST", url)

print(response.text)
A binary file was returned

You couldn't be authenticated

Try the API to see results

Body Params

brand_id
uuid
required

ID of the brand the contact should be created in

email
email
required

Email address of the contact

field_values
array of objects

Field values are saved along with the email as part of the contact.

Each name must match the tag name of a field that exists in the brand.

Each field value must have exactly one of string, integer, or date.

date
integer
name
string
list_ids
array of strings

IDs of lists the contact should be added to

unsubscribe_all
boolean

Set to true to unsubscribe the contact from all future campaigns, regardless of message type.

unsubscribe_ids
array of strings

IDs of message types the contact should be unsubscribed from.

Response

OK

contact_idstring

ID of the contact inserted

Bad Request

codestring

an application-specific error code, expressed as a string value.

detailstring

a human-readable explanation specific to this occurrence of the problem.

idstring

a unique identifier for this particular occurrence of the problem.

metaobject

a meta object containing non-standard meta-information about the error.

statusstring

the HTTP status code applicable to this problem, expressed as a string value.

Unprocessable Entity

codestring

an application-specific error code, expressed as a string value.

detailstring

a human-readable explanation specific to this occurrence of the problem.

idstring

a unique identifier for this particular occurrence of the problem.

metaobject

a meta object containing non-standard meta-information about the error.

statusstring

the HTTP status code applicable to this problem, expressed as a string value.

Internal Server Error

Suggest Edits

Update contact

Update a contact. Any parameters not provided are left unchanged.

 

Header Auth

 Authentication is required for this endpoint.
posthttps://api.bigmailer.io/v1/contacts/contact_id
curl --request POST \
  --url https://api.bigmailer.io/v1/contacts/contact_id
var request = require("request");

var options = { method: 'POST',
  url: 'https://api.bigmailer.io/v1/contacts/contact_id' };

request(options, function (error, response, body) {
  if (error) throw new Error(error);

  console.log(body);
});
require 'uri'
require 'net/http'

url = URI("https://api.bigmailer.io/v1/contacts/contact_id")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Post.new(url)

response = http.request(request)
puts response.read_body
var data = JSON.stringify(false);

var xhr = new XMLHttpRequest();
xhr.withCredentials = true;

xhr.addEventListener("readystatechange", function () {
  if (this.readyState === this.DONE) {
    console.log(this.responseText);
  }
});

xhr.open("POST", "https://api.bigmailer.io/v1/contacts/contact_id");

xhr.send(data);
import requests

url = "https://api.bigmailer.io/v1/contacts/contact_id"

response = requests.request("POST", url)

print(response.text)
A binary file was returned

You couldn't be authenticated

Try the API to see results

Path Params

contact_id
string
required

Id of the contact

Body Params

brand_id
uuid
required

ID of the brand the contact is in. brand_id must match the brand id specified when the contact was created. A contact's brand cannot be changed.

email
email

Email address of the contact

field_values
array of objects

Field values are saved along with the email as part of the contact.

Each name must match the tag name of a field that exists in the brand.

Each field value must have exactly one of string, integer, or date.

date
integer
name
string
list_ids
array of strings

IDs of lists the contact should be added to

unsubscribe_all
boolean

Set to true to unsubscribe the contact from all future campaigns, regardless of message type.

unsubscribe_ids
array of strings

IDs of message types the contact should be unsubscribed from.

Response

OK

contact_idstring

ID of the contact updated

Bad Request

codestring

an application-specific error code, expressed as a string value.

detailstring

a human-readable explanation specific to this occurrence of the problem.

idstring

a unique identifier for this particular occurrence of the problem.

metaobject

a meta object containing non-standard meta-information about the error.

statusstring

the HTTP status code applicable to this problem, expressed as a string value.

Not Found

codestring

an application-specific error code, expressed as a string value.

detailstring

a human-readable explanation specific to this occurrence of the problem.

idstring

a unique identifier for this particular occurrence of the problem.

metaobject

a meta object containing non-standard meta-information about the error.

statusstring

the HTTP status code applicable to this problem, expressed as a string value.

Unprocessable Entity

codestring

an application-specific error code, expressed as a string value.

detailstring

a human-readable explanation specific to this occurrence of the problem.

idstring

a unique identifier for this particular occurrence of the problem.

metaobject

a meta object containing non-standard meta-information about the error.

statusstring

the HTTP status code applicable to this problem, expressed as a string value.

Internal Server Error

Suggest Edits

Transactional Campaigns

 
Suggest Edits

Send a transactional email

Send an email as part of a transactional campaign

 

Header Auth

 Authentication is required for this endpoint.
posthttps://api.bigmailer.io/v1/transactional-campaigns/campaign_id/send
curl --request POST \
  --url https://api.bigmailer.io/v1/transactional-campaigns/campaign_id/send
var request = require("request");

var options = { method: 'POST',
  url: 'https://api.bigmailer.io/v1/transactional-campaigns/campaign_id/send' };

request(options, function (error, response, body) {
  if (error) throw new Error(error);

  console.log(body);
});
require 'uri'
require 'net/http'

url = URI("https://api.bigmailer.io/v1/transactional-campaigns/campaign_id/send")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Post.new(url)

response = http.request(request)
puts response.read_body
var data = JSON.stringify(false);

var xhr = new XMLHttpRequest();
xhr.withCredentials = true;

xhr.addEventListener("readystatechange", function () {
  if (this.readyState === this.DONE) {
    console.log(this.responseText);
  }
});

xhr.open("POST", "https://api.bigmailer.io/v1/transactional-campaigns/campaign_id/send");

xhr.send(data);
import requests

url = "https://api.bigmailer.io/v1/transactional-campaigns/campaign_id/send"

response = requests.request("POST", url)

print(response.text)
A binary file was returned

You couldn't be authenticated

Try the API to see results

Path Params

campaign_id
string
required

Id of the campaign

Body Params

email
email
required

Email address of the contact

field_values
array of objects

Field values are saved along with the email as part of the contact. Additionally, they are used as variables when generating the email content (body, subject, and recipient name).

Each name must match the tag name of a field that exists in the brand.

Each field value must have exactly one of string, integer, or date.

date
integer
name
string
variables
array of objects

Variables to substitute into the email content (body, subject, and recipient name). Unlike field_values, they are NOT saved as part of the contact.

name
value

Response

OK

contact_idstring

ID of the contact inserted or updated

Bad Request

codestring

an application-specific error code, expressed as a string value.

detailstring

a human-readable explanation specific to this occurrence of the problem.

idstring

a unique identifier for this particular occurrence of the problem.

metaobject

a meta object containing non-standard meta-information about the error.

statusstring

the HTTP status code applicable to this problem, expressed as a string value.

Not Found

codestring

an application-specific error code, expressed as a string value.

detailstring

a human-readable explanation specific to this occurrence of the problem.

idstring

a unique identifier for this particular occurrence of the problem.

metaobject

a meta object containing non-standard meta-information about the error.

statusstring

the HTTP status code applicable to this problem, expressed as a string value.

Internal Server Error