REST API

REST API

Legacy Poppulo platform REST API

Create Mail Job

Overview

NameDescription
HTTP MethodPOST
URLhttps://api.newsweaver.com/v2/{account code}/issue/{issue id}/mailings
Query ParametersN/A
Request representationMail Job Entity
Response representationStatus Entity
Success Response Code202 Accepted

Errors

  • 403 - Forbidden if API user doesn't have CREATE access to SEND
  • 409 - Conflict error if the mail job is not valid. Examples of validation errors:
    • No targets specified or the targets do not exist
    • No sender details (from name/address not specified and not defaults exist)
    • No subscribers are matched (e.g. tag is empty or all subscribers have received the issue already)
    • Email quota has been exceeded
  • Common errors (user/account authentication errors, API usage limit errors)