API v1.0.2 Documentation
Jump To
XML-RPC DocumentationCampaign Methods
List Methods
Subscriber Methods
Account Methods
Agency Methods
Other Methods
Errors
Endpoints
Access to the API is through the endpoint located at http://api.mynewsletterbuilder.com/1.0.2/. Each versioned endpoint
guarantees that you can build against the interface provided without worrying about your
code breaking when we make a change. Any incompatible change will appear at a new versioned endpoint.
Return Types
- XMLRPC: Your client should connect to http://api.mynewsletterbuilder.com/1.0.2/
- JSON: http://api.mynewsletterbuilder.com/1.0.2/METHOD_NAME/json?parameters_here
- Serialized PHP: http://api.mynewsletterbuilder.com/1.0.2/METHOD_NAME/php?parameters_here
- XML: http://api.mynewsletterbuilder.com/1.0.2/METHOD_NAME/xml?parameters_here
Secure Connections
The API supports a secure SSL/TLS connection. For the wrappers we provide you simply need specify the use of a secure connection (see the wrapper documentation).
If you are not using a wrapper, simply point the connection to https://api.mynewsletterbuilder.com/1.0.2/.
XML-RPC Documentation
You can access the XML-RPC specific documentation at:
Core Service or
Agency Service
Campaigns
Campaigns: Retrieve a list of campaigns from your account. |
CampaignDetails: Get details about a specific campaign. |
CampaignCreate: Create a new campaign for your account. |
CampaignUpdate: Update an existing campaign. |
CampaignCopy: Create a copy of an existing campaign. |
CampaignDelete: Delete a campaign from your account. |
CampaignSchedule: Schedule a campaign for delivery. |
CampaignStats: Retrieve campaign reporting data. |
CampaignRecipients: Retrieve a list of recipients for a sent campaign. |
CampaignOpens: Retrieve a list of subscribers that opened the campaign. |
CampaignSubscribes: Retrieve a list of subscribers that joined through the campaign. |
CampaignUnsubscribes: Retrieve a list of subscribers that unsubscribed through the campaign. |
CampaignBounces: Retrieve a list of subscribers who's email bounced for the campaign. |
CampaignComplaints: Retrieve a list of subscribers who complained for the campaign. |
CampaignUrls: Retrieve link tracking data for the campaign. |
CampaignClicks: Retrieve a list of subscribers who have clicked in the campaign. |
CampaignClickDetails: Retrieve details about specific URL clicks. |
Lists
Lists: Retrieve subscriber lists for the account. |
ListDetails: Get information about a specific list. |
ListCreate: Create a new subscriber list. |
ListUpdate: Update an existing subscriber list. |
ListDelete: Delete a subscriber list. |
Subscribers
Subscribers: Retrieve a list of your subscribers. |
SubscriberDetails: Retrieve data about a particular subscriber. |
SubscriberUpdate: Update a subscriber record. |
Subscribe: Add a single subscriber to your account. |
SubscribeBatch: Batch add subscribers to your account. |
SubscriberUnsubscribe: Unsubscribe a single subscriber to your account. |
SubscriberUnsubscribeBatch: Batch unsubscribe subscribers from your account. |
SubscriberDelete: Delete a single subscriber to your account. |
SubscriberDeleteBatch: Batch delete subscribers from your account. |
Accounts
AccountDetails: Retrieve account information |
AccountKeys: Retrieve API keys for the account. Requires authentication. |
AccountKeyCreate: Create a new API key. Requires authentication. |
AccountKeyEnable: Enable a previously disabled API key. Requires authentication. |
AccountKeyDisable: Disable an API key. Requires authentication. |
Agency Methods
EnterpriseCreateSubAccount: Add a sub-account to your agency. |
EnterpriseEnableSubAccount: Enable an agency sub-account. |
EnterpriseDisableSubAccount: Disable an agency sub-account. |
EnterpriseSubAccountStatus: Get the enabled status of an agency sub-account. |
Errors & Exceptions
The system generates errors and exceptions from a defined set. Please see here for a list of error codes and descriptions that the service may return to you. |