BigMailer

BigMailer integration (Marketing, Communication). Imported from open-connector.

API key13 toolshttps://api.bigmailer.io

GET

bigmailer_list_brands

List brands in the BigMailer account.

/v1/brands

2 parameters

Param	Type	Required	Description
limit	integer	optional	The maximum number of objects to return.
cursor	string	optional	The pagination cursor returned by a previous BigMailer response.

GET

bigmailer_get_brand

Get one BigMailer brand by ID.

/v1/brands/{brandId}

1 parameter

Param	Type	Required	Description
brandId	string	required	The BigMailer brand ID.

GET

bigmailer_list_lists

List contact lists in a BigMailer brand.

/v1/brands/{brandId}/lists

3 parameters

Param	Type	Required	Description
brandId	string	required	The BigMailer brand ID.
limit	integer	optional	The maximum number of objects to return.
cursor	string	optional	The pagination cursor returned by a previous BigMailer response.

POST

bigmailer_create_list

Create a contact list in a BigMailer brand.

/v1/brands/{brandId}/lists

2 parameters

Param	Type	Required	Description
brandId	string	required	The BigMailer brand ID.
name	string	required	The list name.

GET

bigmailer_get_list

Get one BigMailer contact list by ID.

/v1/brands/{brandId}/lists/{listId}

2 parameters

Param	Type	Required	Description
brandId	string	required	The BigMailer brand ID.
listId	string	required	The BigMailer list ID.

POST

bigmailer_update_list

Update a BigMailer contact list name.

/v1/brands/{brandId}/lists/{listId}

3 parameters

Param	Type	Required	Description
brandId	string	required	The BigMailer brand ID.
listId	string	required	The BigMailer list ID.
name	string	required	The new list name.

DELETE

bigmailer_delete_list

Delete a BigMailer contact list without deleting its contacts.

/v1/brands/{brandId}/lists/{listId}

2 parameters

Param	Type	Required	Description
brandId	string	required	The BigMailer brand ID.
listId	string	required	The BigMailer list ID.

GET

bigmailer_list_contacts

List contacts in a BigMailer brand, optionally filtered by list.

/v1/brands/{brandId}/contacts

4 parameters

Param	Type	Required	Description
brandId	string	required	The BigMailer brand ID.
limit	integer	optional	The maximum number of objects to return.
cursor	string	optional	The pagination cursor returned by a previous BigMailer response.
listId	string	optional	The BigMailer list ID.

POST

bigmailer_create_contact

Create a contact in a BigMailer brand.

/v1/brands/{brandId}/contacts

7 parameters

Param	Type	Required	Description
brandId	string	required	The BigMailer brand ID.
validate	boolean	optional	Whether BigMailer should validate email deliverability before adding the contac…
email	string	required	The contact email address.
fieldValues	array	optional	Field values to save with the contact. Each name must match a BigMailer field t…
listIds	array	optional	IDs of lists the contact should belong to.
unsubscribeAll	boolean	optional	Whether to unsubscribe the contact from all future campaigns regardless of mess…
unsubscribeIds	array	optional	IDs of message types the contact should be unsubscribed from.

GET

bigmailer_get_contact

Get one BigMailer contact by ID or email address.

/v1/brands/{brandId}/contacts/{contactId}

2 parameters

Param	Type	Required	Description
brandId	string	required	The BigMailer brand ID.
contactId	string	required	The BigMailer contact ID or email address.

POST

bigmailer_update_contact

Update a BigMailer contact by ID or email address.

/v1/brands/{brandId}/contacts/{contactId}

10 parameters

Param	Type	Required	Description
brandId	string	required	The BigMailer brand ID.
contactId	string	required	The BigMailer contact ID or email address.
fieldValuesOp	string	optional	How BigMailer should apply the supplied values.
listIdsOp	string	optional	How BigMailer should apply the supplied values.
unsubscribeIdsOp	string	optional	How BigMailer should apply the supplied values.
email	string	optional	The contact email address.
fieldValues	array	optional	Field values to save with the contact. Each name must match a BigMailer field t…
listIds	array	optional	IDs of lists the contact should belong to.
unsubscribeAll	boolean	optional	Whether to unsubscribe the contact from all future campaigns regardless of mess…
unsubscribeIds	array	optional	IDs of message types the contact should be unsubscribed from.

POST

bigmailer_upsert_contact

Create or update a BigMailer contact by email address.

/v1/brands/{brandId}/contacts/upsert

7 parameters

Param	Type	Required	Description
brandId	string	required	The BigMailer brand ID.
validate	boolean	optional	Whether BigMailer should validate email deliverability before adding the contac…
email	string	required	The contact email address.
fieldValues	array	optional	Field values to save with the contact. Each name must match a BigMailer field t…
listIds	array	optional	IDs of lists the contact should belong to.
unsubscribeAll	boolean	optional	Whether to unsubscribe the contact from all future campaigns regardless of mess…
unsubscribeIds	array	optional	IDs of message types the contact should be unsubscribed from.

DELETE

bigmailer_delete_contact

Delete a BigMailer contact by ID or email address.

/v1/brands/{brandId}/contacts/{contactId}

2 parameters

Param	Type	Required	Description
brandId	string	required	The BigMailer brand ID.
contactId	string	required	The BigMailer contact ID or email address.