API References

Each of these references encompasses the entirety of that object within the platform, via the FACADE. If there are unique methods these are given, followed by an example of the parameters passed when carrying out a key operation, i.e. Creating a list.

The writeable variables of the ENTITY are provided with the required and optional options, these are passed during an UPDATE or STORE default bean method, therefore updating the bean in the bean store before writing this back to the platform and updating the system.

Where listed, and possible, BASE 64 ENCODE your strings and use the variable ending in "_base64".

The search parameters that can be loaded on to the SEARCH bean are also covered.

To continue just simply click on the area you'd like to reference. If you're unsure what this is please check the Getting Started documentation


bus_facade_context

Used in the management of a session, logging in, creating a session and logging out.
Read More

bus_facade_campaign_list

Used in the management of contact lists within the platform, creating, appending, replacing and removing
Read More

bus_facade_campaign_filters

Used in the management of list filters within the platform, creating, updating and removing.
Read More

bus_facade_campaign_email

Used in the management of email messages within the platform, creating, updating and removing.
Read More

bus_facade_campaign_sms

Used in the management of SMS within the platform, creating, updating and removing.
Read More

bus_facade_campaign_delivery

Used in the management of deliveries within the platform, creating, updating, removing, basic reporting.
Read More

bus_facade_campaign_one2one

Used in the management of one2one deliveries within the platform, creating, updating (before send), cancelling.
Read More

bus_facade_campaign_contentItem

Used in the management of dynamic content items within the platform, creating, updating, removing.
Read More

bus_facade_campaign_automationByDate

Used in the management of date automations within the platform, creating, updating, removing.
Read More

bus_facade_campaign_automationBySignup

Used in the management of signup automations within the platform, creating, updating, removing.
Read More

bus_facade_campaign_automation

Used in the management of status of automations within the platform.
Read More

bus_facade_campaign_dynamicRegion

Used in the management of dynamicRegions in parent emails within the platform, creating, updating, removing.
Read More

bus_facade_eventNotification

Used in the retrieval of event notification data configure to the CLIENT PULL process.
Read More

bus_facade_campaign_message

Used for searching for specific, or a range, of messages within the platform.
Read More