Notifications Service

Email

An Electronic Mail Message

Object definition

View properties and constraints defined on the object

Show definition

POST Create email

Create a new Email

POST /emails

Required parameters

Name /typeDescription /exampleConstraints
subject
string

The email's subject

"Oh hai there"
    body
    object
    { "text": "How you doing?", "html": "Check this out <br> <img src=\"http://i.ytimg.com/vi/J---aiyznGQ/hqdefault.jpg\" alt=\"Logo\" title=\"Logo\" style=\"display:block\" width=\"200\" height=\"87\" />" }
      to
      object
      { "address": "dog@example.com", "name": "Mr Dog" }

        Optional parameters

        Name /typeDescription /exampleConstraints
        from
        object
        { "address": "cat@example.com", "name": "Keyboard Cat" }

          cURL

          curl -X POST "https://localhost:3000/v1/emails" \
     -H "Content-Type: application/json" \
     --data '{"subject":"Oh hai there","body":{"text":"How you doing?","html":"Check this out <br> <img src=\"http://i.ytimg.com/vi/J---aiyznGQ/hqdefault.jpg\" alt=\"Logo\" title=\"Logo\" style=\"display:block\" width=\"200\" height=\"87\" />"},"to":{"address":"dog@example.com","name":"Mr Dog"},"from":{"address":"cat@example.com","name":"Keyboard Cat"}}'

          Response

          {
  "subject": "Oh hai there",
  "body": {
    "text": "How you doing?",
    "html": "Check this out <br> <img src=\"http://i.ytimg.com/vi/J---aiyznGQ/hqdefault.jpg\" alt=\"Logo\" title=\"Logo\" style=\"display:block\" width=\"200\" height=\"87\" />"
  },
  "to": {
    "address": "dog@example.com",
    "name": "Mr Dog"
  },
  "from": {
    "address": "cat@example.com",
    "name": "Keyboard Cat"
  }
}

          Sms

          A message sent via Short Message Service

          Object definition

          View properties and constraints defined on the object

          Show definition

          POST Create sms

          Create a new Sms

          POST /smss

          Required parameters

          Name /typeDescription /exampleConstraints
          body
          string

          The text of your sms.

          "How is it going?"
            to
            string

            The number you're trying to send an sms to

            "+61438000000"

              Optional parameters

              Name /typeDescription /exampleConstraints
              from
              string

              The number you're trying to send an sms from

              "61438000000"

                cURL

                curl -X POST "https://localhost:3000/v1/smss" \
     -H "Content-Type: application/json" \
     --data '{"body":"How is it going?","to":"+61438000000","from":"61438000000"}'

                Response

                {
  "body": "How is it going?",
  "to": "+61438000000",
  "from": "61438000000"
}