Guides
API Reference

Upload a batch of contacts

post
https://api.bigmailer.io/v1/brands//contacts/batches

Upload a batch of up to 1,000 contacts to be created or updated. The contacts are processed asynchronously.

Path Params
uuid
required

ID of the brand to upsert the contacts in

Body Params
boolean

Set to true to validate emails for deliverability before adding contacts. Validation credits must be purchased before using this feature. Contacts with emails that do not validate will not be added.

items
array of objects
required
length between 1 and 1000
items*
string
required
length between 1 and 100

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.

field_values
list_ids
array of uuids

IDs of lists the contact should be added to

list_ids
boolean
Defaults to false

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

unsubscribe_ids
array of uuids

IDs of message types the contact should be unsubscribed from.

unsubscribe_ids
string
length ≤ 80

A user defined id or other value. It should be unique within a request. The value is not stored with the contact. It appears in the results once the batch is imported. Use it to correlate the results of the batch import to contacts in your system.

Responses

Updated about 2 months ago

Language
Credentials
Header
Response 
Click Try It! to start a request and see the response here! Or choose an example:
application/json
Updated about 2 months ago