SOAP API
Using the SOAP API
Note: the SOAP API is a legacy import feature that is no longer updated with new calls. Instead, you should use the REST API to transfer data.
In addition to importing data via the UI, you may transfer data to using the SOAP API.
To use the SOAP API for imports you will first need to create an import template. The associated import template ID is needed to complete an automated import.
To use the SOAP API for sends you will first need to create a send template. The associated send template ID is needed to complete an automated send, e.g. a triggered mailing.
Tip: you can also use FTP/ Directory Watch to automatically import a file when it is added to a specified directory.
Note: does not allow you to push files into the hosted environment for security reasons.
Accessing PostUp via the SOAP API
Administrators setup a connection to make SOAP calls directly to the application server.
All SOAP APIs for PostUp are made available by connecting to:
https://api.postup.com/services/Soap
The Web Service Description Language (WSDL) file for the PostUp SOAP API is made available by connecting to:
https://api.postup.com/services/Soap?wsdl
The WSDL document describes the operations and the complex data types used as input or output parameters for retrieving information via SOAP calls. Many programming languages offer tools that have the ability to convert the WSDL file into a set of stub classes, turning the SOAP calls into the API.
To establish authentication:
- Pass the username and password parameters in the SOAP header.
- The username and password must map to a valid PostUp user login.
- You can only use a site level administrator’s login for the API calls.
Tip: create a separate user account for the sole purpose of making SOAP calls. Creating a separate account prevents accidental deletion.
Furthermore, you may deselect the permission for logging into the UI to ensure users do not use the account to log into the PostUp interface.
You can use the SOAP API for:
- Recipient management.
- List management.
- List subscription management.
- Importing data.
- Send templates management.
- Triggered messages management.
- as a passthrough.
- Mailings.
- Reports.
- Content management.
- Custom Fields management.
- Exports.
- SMS.
- Site monitoring.
Tip: to view the SOAP API version, use the getVersion command. This method takes no arguments but does require authentication in the headers.