Create Message From URL

Create Message From URL


Function

  • createMessageFromURL()

Url

  • POST: /PuresendService/v1/createMessageFromUrl

Parameters

  • name: String
    • name of content message.
  • categoryId: int
    • category to create Message in.
    • -1 for default top level category.
  • htmlContentURL: String
    • message content URL for html based viewing
  • textContentURL: String
    • message content URL for text viewing allowed.
  • mobileContentURL: String
    • message content URL for mobile viewing allowed.
  • headerId: int
    • content ID of header
  • footerId: int
    • content ID of footer

Return

  • messageId: int
    • message ID: the newly created message id

Exception

  • PuresendException

Documentation

  • Sets and post-processes the specified content type to the contents of the specified URL and creates a Message.
  • Fails if the MIME type returned by the URL doesn’t match the requested MIME type.

Examples

{
    "messageName" : "New Message Name",
    "categoryId" : -1,
    "htmlContentUrl" : "https://www.google.com/",
    "textContentUrl" : "",
    "mobileContentUrl" : "",
    "headerId" : 0,
    "footerId": 0
}
{
    "messageId": 12345
}