Guides
API Reference

Create or update contact

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

Create or update a contact. If the specified email does not exist, a new contact is created. If the specified email exists, the existing contact is updated.

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Path Params
uuid
required

ID of the brand to create or update the contact in

Query Params
string
enum
Defaults to false

Set to true to validate the email for deliverability before adding the contact. Validation credits must be purchased before using this feature. The API does not add the contact and returns an error if the email is undeliverable.

Allowed:
Body Params
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
Responses

Updated about 2 months ago

Language
Credentials
Header
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json

Updated about 2 months ago