Update contact

post

https://api.bigmailer.io/v1/brands/{brand_id}/contacts/{contact_id}

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

Path Params

brand_id

uuid

required

ID of the brand to update the contact in

contact_id

string

required

ID or email address of the contact

Query Params

field_values_op

string

enum

Defaults to replace

Controls how the API uses the supplied field_values object.

add - Copy properties in the supplied field_values into the contact's field_values. Supplied field values overwrite contact field values with the same name. Field values not supplied are preserved.

replace - Replace the contact's field_values object with the supplied field_values. Field values not supplied are removed from the contact.

remove - Remove supplied field_values from the contact's field_values.

Allowed:

list_ids_op

string

enum

Defaults to replace

Controls how the API uses the supplied list_ids array.

add - Append supplied list_ids to the contact's existing list_ids array.

replace - Replace the contact's list_ids array with the supplied list_ids.

remove - Remove supplied list_ids from the contact's existing list_ids array.

Allowed:

unsubscribe_ids_op

string

enum

Defaults to replace

Controls how the API uses the supplied unsubscribe_ids array.

add - Append supplied unsubscribe_ids to the contact's existing unsubscribe_ids array.

replace - Replace the contact's unsubscribe_ids array with the supplied unsubscribe_ids.

remove - Remove supplied unsubscribe_ids from the contact's existing unsubscribe_ids array.

Allowed:

Body Params

string

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

unsubscribe_all

boolean

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

200Contact successfully updated

400The request was invalid.

401The API key does not exist.

403The system understands the request but refuses to authorize it.

404Brand or contact does not exist

422Contact already exists with email

429The client has made too many requests.

500An unexpected error occurred.

502The system is under heavy load or is down temporarily.

503The system is under maintenance. Please try again later.

504The system timed out processing your request.