Contents x
    /message/sendTransactional
    • 1 Minute to read
    • Print
    • Dark
      Light
    Contents

    /message/sendTransactional

    • 1 Minute to read
    • Print
    • Dark
      Light
    Article summary

    Post
    /message/sendTransactional

    Sends a prepared message as a transactional message.
    Attachments may be added as part of the JSON payload. If you wish to attach a file to the message, the data must be Base64 encoded
    and added as the value of the attachment’s content string, as demonstrated below. Request body example with attachment: 

    {
    "parameters":
      [{"name" : "Parameter Name 1","value" : "Parameter Value 1"},
       {"name" : "Parameter Name 2","value": "Parameter Value 2"}],
        "attachments":
        [{"name" : "twitter_logo.png",
          "contentType" : "image/png",
          "content": "iVBORw0KGgoAAAANSUhEUgAAABUAAAARCAYAAAAyhueAAAAAGXRFWHRTb2Z0d2FyZQBBZG9iZSBJbWFnZVJlYWR5ccllPAAAASFJREFUeNqslM0NgkAQhRdiAdiAgQ6468EO1INntQOpwFABdqBe9aAdiIl3twS1AbECfJPMkhVZftSXjJPsDh87z2WsNE1Fb3d3z+POVVQIdQ5ShJhqywdEgEgQQ1qwutsbFT4QM4DXFcALwi3YJqDD2bPx4/PGCg/OSw46NwAFA0nU7d7ObUYAHxF+wYMDUU8jiz19aG9TihEbyuS3oSavNmoT5Sm1thA/CkCLsvJ0In5XdnsIKkv+gCaSGZQ8QF7+AXrST0peBH8Ar9+grKfuS1Mgd/wBjb/0lmChvmBr14GgMy5qoiA/N+zcPSNfPN2fCoVF86KlDQxqvc93tl8DaBxALcAi/qLqKuaWpalAffsOz8iB4ZRSzYIymNJLgAEAYsJkJOLW//gAAAAASUVORK5CYII="}]
    }

    Query parameters
    messageId
    integer (int64)

    ID of the message or prepared message

    externalTransactionFormula
    string

    External transactional identifier. If not available, "null" can be used.

    recipientId
    integer (int64)

    ID of the user

    senderProfileName
    string

    TLS sender profile. Requires a Feature Switch and setting up a profile name in Mapp Engage. (optional)

    Body parameters
    Expand All
    object
    parameters
    Array of object (Attribute)
    object
    name
    string
    value
    string
    attachments
    Array of object (Attachment)
    object
    name
    string
    contentType
    string
    content
    string
    Responses
    204
    400

    Missing parameter or parameter value, for example:

    {
      "errorActor": "CLIENT",
      "errorCode": "MISSING_PARAMETER",
      "message": "Parameter 'messageId' is mandatory but no value was specified.",
      "parameterName": "messageId",
      "propertyName": null,
      "value": "null"
    }


    Message ID or recipient does not exist, for example:

    {
      "errorActor": "CLIENT",
      "errorCode": "NO_SUCH_OBJECT",
      "message": "Message with id=24011454555 does not exist.",
      "objectType": "Message",
      "propertyName": "id",
      "propertyValue": "24011454555"
    }

    Was this article helpful?
    What's Next