|
| API Method | HTTP method | Endpoint | Description |
|---|
| newsletter.getProps | GET | /newsletter.getProps.json | Returns a hash array with the properties of a newsletter |
| newsletter.getProp | GET | /newsletter.getProp.json | Returns the specified property of a newsletter |
| newsletter.updateProps | POST | /newsletter.updateProps.json | Updates the properties of a newsletter |
| newsletter.updateProp | POST | /newsletter.updateProp.json | Updates one property of a newsletter |
| newsletter.pause | POST | /newsletter.pause.json | Pauses a sending newsletter |
| newsletter.resume | POST | /newsletter.resume.json | Resumes a paused newsletter |
| newsletter.schedule | POST | /newsletter.schedule.json | Schedules a newsletter to be sent in the future |
| newsletter.cancel | POST | /newsletter.cancel.json | Cancels a newsletter |
| newsletter.confirm | POST | /newsletter.confirm.json | Confirms a newsletter via API |
| newsletter.sendConfirm | POST | /newsletter.sendConfirm.json | Sends a newsletter confirmation mail |
| newsletter.create | POST | /newsletter.create.json | Creates a new newsletter in this list |
| newsletter.getSegments | GET | /newsletter.getSegments.json | Returns a hash array with the segments of a newsletter |
| newsletter.getExcludedSegments | GET | /newsletter.getExcludedSegments.json | Returns a hash array with the excluded segments of a newsletter |
| newsletter.setSegments | POST | /newsletter.setSegments.json | Updates the segments of a newsletter |
| newsletter.setExcludedSegments | POST | /newsletter.setExcludedSegments.json | Updates the excluded segments of a newsletter |
| newsletter.setAlternateContent | GET | /newsletter.setAlternateContent.json | Sets the alternate content for a newsletter (viewable online at ##NEWSMAN:view_online##?akey=) |
| newsletter.all | GET | /newsletter.all.json | Returns a list of newsletters with status $status between $start_date, $stop_date (inclusive). The method can also return results in CSV format by using the CSV output format: newsletter.all.csv |
| newsletter.update | POST | /newsletter.update.json | Updates a new newsletter in this list (unconfirmed only) |
| newsletter.sendTest | POST | /newsletter.sendTest.json | Sends a test to the specified emails |
| newsletter.stats | GET | /newsletter.stats.json | Returns stats for the specified newsletter |
| newsletter.linksClicked | GET | /newsletter.linksClicked.json | Returns links clicked for the specified newsletter |
| newsletter.restart | POST | /newsletter.restart.json | Restarts a cancelled / sent newsletter |
| newsletter.subscribersHistory | GET | /newsletter.subscribersHistory.json | Returns an array with the history entries for the subscribers of a newsletter |
| newsletter.statusactions | GET | /newsletter.statusactions.json | Returns info about the newsletter status and actions which may be taken |
