updateContacts

The updateContacts function allows you to update contact(s) and associated data.

Syntax

writeResult = bApi.updateContacts(contactObject[] contacts);

Attributes

Name Type Required Description
id string No The unique id for the contact. Either id or email is required to locate the object. You can obtain the id for a contact by calling readContacts, or by looking at the footer when viewing the overview page for an individual contact in the application. The id, mobileNumber, or email is required to locate the contactObject.
email string No The email address assigned to the contact. The id, mobileNumber, or email is required to locate the contactObject.
mobileNumber string No The mobile number stored for the contact. The id, mobileNumber, or email is required to locate the contactObject. A valid country code must be included when updating a mobile number for a contact.
status string No The status of the contact. The status can be set to transactional, onboarding, unconfirmed, unsub, or bounce.

Notes:

    • You cannot change a contact’s status directly to active. Rather, you need to switch their status to onboarding so that they can be run through the automated onboarding process.
    • While you can change a contact’s status to bounce, we recommend you do not do this unless you are doing so as part of a bulk import while moving to Bronto from another platform.
    • You can not update a contact’s status if they are on the suppression list.
    • If a contact has a status of onboarding, you can update their status to bounce,transactional, unconfirmed, or unsub, but not active.
CAUTION: Changing a contact’s status can have implications on your ability to send email to them. For an explanation of each type of contact status, view the description for status on the contactObject page.
msgPref string No The message preference for the contact. A contact can have a message preference of text or html.
source string No The source or where the contact came from. The source can be manual, import, api, webform, or sforcereport (Salesforce report).
customSource string No A source you define that states where the contact came from.
listIds string, array. Use an array for multiple ids No The lists (referenced by ID) that the contact belongs to. You obtain listIds by calling the readLists function.

The lists you set in this call are absolute, not incremental, to lists the contact may already be on. This means contacts are removed from any list(s) not specified in this call and will only be added to lists you specify in this call. If you pass an empty array for listId or do not pass the listId parameter, list membership will remain unchanged.

If you want to

  • Incrementally add a contact to a list without affecting their membership on other lists, use the addToList function.
  • Incrementally remove a contact from a list, use the removeFromList function.

If you want to use this call to incrementally add the contact to a new list and retain their current list membership, you’ll need to

  • Call readContacts.
  • Obtain the ids for the lists the contact is currently a member of.
  • Pass in those ids along with the new list ids when calling updateContacts.
fields contactField[] No An array of the fields and corresponding field data associated with the contact.
SMSKeywordIDs string, array. Use an array for multiple ids No An array of the SMS keyword ids you want to subscribe the contact to.