The MailBuild API will allow you or your clients to perform a range of operations on their accounts, including the addition and removal of subscribers to their lists.
Format
To keep things simple, the MailBuild API uses SOAP as the format for accessing the API methods. For anyone not familiar with SOAP, we've put together a quick tutorial on how anyone can post a SOAP request to the API.
Getting Started
-
Your service URL
First and foremost, you need the URL at which the service is located. You can access the service at the following address:
http://yoursitename.createsend.com/api/api.asmxIn the example above,
yoursitenameis the MailBuild site address you specified when signing up. You can change this value at any time via the Customize tab in your account. If you need to access the WSDL service description, use the following URL, again replacingyoursitename:http://yoursitename.createsend.com/api/api.asmx?wsdl -
Your API key and list ID's
To gain access to your client's lists, all you'll need is your API key and the ID of that specific list.
Getting your API key
To get started, you need to generate your own API key. To do this , head into your admin account, click on "My Account" in the top right and one the right you'll notice a link to "Generate your API key".
Once your key is generated, you can access it from your Account Settings at any time.
Getting your Subscriber List ID
As soon as you generate your API key, you can access the ID for each of your client's lists by heading into their account and clicking on their list. Then, click on the "Update list name and type" link under List Options on the bottom right. The API List ID will be shown at the bottom of this page just like the image below.
Methods
The following API methods are currently available to remotely manage your client's subscribers.
- Subscriber.Add
- Subscriber.AddWithCustomFields
- Subscriber.Unsubscribe
- Subscribers.GetActive
- Subscribers.GetUnsubscribed
- Subscribers.GetBounced
