Bronto Knowledge Base

Create and Design
Send
Automate
Organize
Report
View or Export
Import
Integrate
API
Manage
Apps
About

Home
API
The Bronto API is designed for developers. The API exposes nearly all of the capabilities presented in the graphical user interface.
SOAP API
The Bronto API was built on the SOAP web service, so most of the interactions you have with Bronto’s API will be SOAP-based.
SOAP Settings Objects
Settings objects are specific to modifying the Bronto platform’s account settings.

SOAP Settings Objects

Settings objects are specific to modifying the Bronto platform’s account settings.

API
The Bronto API is designed for developers. The API exposes nearly all of the capabilities presented in the graphical user interface.
- SOAP API
  The Bronto API was built on the SOAP web service, so most of the interactions you have with Bronto’s API will be SOAP-based.
  - Login To The SOAP API
    All API calls require the existence of an active, authenticated session.
  - Read SOAP Objects
    All of the read functions have a similar structure, requiring a page number, an optional filter, and some additional parameters. Read functions return an object or objects pertaining to the call that was made.
  - Write SOAP Objects
    The API has two distinct groups of functions used for writing objects: “add” functions and “update” functions. Add functions will fail for pre-existing objects, and update functions will fail for non-existing objects.
  - SOAP Add Functions
    Add functions help you add new content to the Bronto platform. This can include things like adding contacts, delivery groups, lists, messages, etc.
  - SOAP Update Functions
    Update functions allow you to make changes to existing data in the Bronto platform. If you want to add data to Bronto you should use an add function.
  - SOAP Delete Functions
    Delete functions help you to remove data from the Bronto platform. Always carefully consider what impact deleting data can have on other aspects of the platform.
  - SOAP Misc Functions
    Miscellaneous functions are functions that do not easily fit into one of the other categories provided.
  - SOAP Read Functions
    Read functions allow you to retrieve information. Often you may need to use a read function to get data that you will need to use to complete an API task.
  - Results of Add, Update, and Delete Functions
    Add, update, and delete functions return a writeResult object. This object contains two arrays: results and errors. The results array will contain N resultItem objects, where N is the number of objects you provided for the function.
  - SOAP Filter Objects
    Filter are objects that you can apply to your SOAP calls. They are used to target a specific subset of the object you are working with.
  - SOAP Settings Objects
    Settings objects are specific to modifying the Bronto platform’s account settings.
    - accountAllocations
      The accountAllocations settings let you allocate features to accounts.
    - contactInformation
      The contact information settings are important because you must provide your company or organization name and full postal mailing address in every message in order to be CAN-SPAM compliant.
    - Country Codes
      When adding or updating an account, you must use a two letter country code when specifying the country. A list of countries and their corresponding two letter code are listed below.
    - formatSettings
      All the times in the account are dependent on the time zone settings you specify for the form. For example, if you set the time zone setting to America/New_York, then all time dependent settings in the account (such as message send times) will be set according to America/New_York time.
    - generalSettings
      The general settings let you define the general settings for an account. Depending on the function you are calling (addAccounts or updateAccounts), different allocation settings will be required. Make sure you view the appropriate Required column for the function you want to call below. Calling readAccounts will return all of the allocations settings associated with the account object.
    - readOnlyContactData
      The readOnlyContactData object contains read-only contact level data returned when calling readContacts.
    - repliesSettings
      The following settings are applied to email replies that are handled by the application when reply tracking is enabled for a delivery. Reply classification, similar to spam filtering, cannot perfectly identify all emails. Before enabling any of these options you should send several deliveries to ensure that the automatic classifications are accurate for your messages.
  - SOAP General Objects
    Here we define the objects you can interact with using Bronto’s SOAP API. This includes general, filter, and error objects.
  - SOAP Data Formats
    Data formats are standard and are defined by the SOAP specification.
- REST API
  Bronto’s newest offerings leverage the convenience and flexibility of REST. With our REST API client, you can access and work with your product and order data.
- API Tutorials
- API Errors
  This is a list of the SOAP and REST API errors you may receive.
- TLS Support
  If you have developed an application that uses the Bronto API on a server, that server uses TLS when connecting to the Bronto application.
- Use the Bronto API To Manage Consent Records
  You can add or update consent records with the addContacts, updateContacts, and/or addOrUpdateContacts calls. The criteria for whether a new consent log entry will be created varies depending on which API method you use.

© Oracle | Terms of Use and Privacy Need Support?