The following table includes the recommended API methods to be used to perform certain tasks. A method in the HTTP Get/Post API and/or a method in the SOAP Web Services API may be available.
Action | Comments | Get/Post API | SOAP Web Services |
Confirm successful communication with the API | This refers to confirming that the API credentials entered by the user are correct. The method used should return useful errors so that the user is informed of what might be going wrong. | ||
Retrieve Lists | This refers to storing the information needed to then enable/disable lists to be shown to users of the application so that they may subscribe/unsubscribe | N/A | |
Retrieve Fields | This refers to storing field ID and field name to allow for mapping between fields in the MailUp account and those in the integrated application. | N/A | |
Single Subscribe | Subscribing a single customer to one or more lists (e.g. during checkout or registration) | ||
Single Unsubscribe | Unsubscribing a single customer from one or more lists (e.g. customer updates their account in the storefront) | ||
Single Update | Updating a single customer based on mapped data fields (e.g. first name, last name, etc | ||
Bulk Subscribe | Subscribing N customers to one or more lists (e.g. customer preferences are saved locally when customers register/checkout) | N/A | |
Bunk Unsubscribe | Unsubscribing N customers from one or more lists (e.g. customer preferences are saved locally when customers register/checkout) | N/A | |
Bulk Update | Updating N customers based on mapped data fields (e.g. first name, last name, etc. and all the ecommerce data fields) | N/A | |
Retrieve subscription status for a specific customer and list | This refers to determining whether a certain customer is subscribed to a given list or not, so that the correct subscription preference can be shown in the ecommerce system (or to update locally stored subscription preferences). |