contactObject

A contact describes an individual email address and/or SMS number in Bronto, along with associated statistics and field data that you have provided.

Name Type Comments
id string The unique id for the contact. The id can be used to reference a specific contact when using the contact functions. 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.
email string The email address assigned to the contact. The email address can be used to reference a specific contact when using the contact functions.
mobileNumber string The mobile number stored for the contact. A valid country code must be included when adding or updating a mobile number for a contact.
status string The status of the contact. Each valid status is described below:

  • active – Active contacts are “live” contacts that can receive both marketing and transactional emails from you.
  • onboardingonboarding contacts are new contacts who are waiting to be sent their first marketing email from you. Once they are sent the first marketing email, they will enter the assessment phase of the automated onboarding process and automatically move from onboarding to Awaiting Assessment, and then to active. You can not update a contact’s status if they currently have a status of onboarding. Contacts with a status of onboarding can receive transactional emails from you.
  • transactional – Contacts with a status of transactional can only be sent transactional emails. A transactional email facilitates an agreed-upon transaction, or updates a customer in an existing business relationship.
  • bounce – The bounce contact status indicates that you cannot send messages to this contact because they have received a hard bounce due to bad email address, or they have exceed the bounce limit for your account.
  • unconfirmed – Contacts with a status of unconfirmed have not yet agreed to receive your marketing email messages. Remember, one of our policies is that contacts must agree to receive your marketing email messages in order for you to send marketing emails to them. Contacts with a status of unconfirmed can receive transactional emails from you.
  • unsub – Contacts with a status of unsub have either unsubscribed themselves from receiving marketing email messages from you, or were unsubscribed by you. Contacts with a status of unsub can receive transactional emails from you.
msgPref string The message preference for the contact. A contact can have a message preference of text or html.
source string The source or where the contact came from. The source can manual, import, api, webform, or sforcereport (salesforce report).
customSource string A source you define that states where the contact came from.
created dateTime The date the contact was created. This timestamp is immutable and cannot be changed
modified dateTime The last time information about the contact was modified. This timestamp is immutable and cannot be changed.
deleted boolean Set to true if the contact has been deleted.
listIds string, array. Use an array for multiple ids The lists (referenced by ID) that the contact belongs to. You can obtain listIds by calling the readLists function.
fields contactField[] Fields and corresponding field data associated with the contact.
SMSKeywordIDs string, array. Use an array for multiple ids An array of the ids corresponding to SMS keywords the contact is subscribed to.
numSends long The total number of deliveries sent to the contact.
numBounces long The total number of times deliveries sent to the contact resulted in a bounce.
numOpens long The total number of times deliveries were opened by the contact. This metric includes multiple opens of the same delivery.
numClicks long The total number of times deliveries were clicked by the contact. If a link is clicked multiple times, each click is included in this metric.
numConversions long The total number of conversions made by the contact.
conversionAmount float The sum/total amount of conversions made by the contact.
readOnlyContactData readOnlyContactData[] An object containing read-only contact level data returned when calling readContacts.

 


Was this article helpful?

Not HelpfulHelpful (-2 rating, 6 votes)
Loading...

We welcome your feedback!

Please let us know how this article could be improved.
*Name and Email are optional fields.