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

    /message/sendSingle

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

    Post
    /message/sendSingle

    Sends a prepared message as a single message to a specific user.

    This method automatically adds the user who receives the email to the group of the prepared message.
    Attachments can be encoded using base64encode.org.
    Request body example: 

    {
    "parameters":
        [{"name" : "Parameter Name 1","value" : "Parameter Value 1"},
         {"name" : "Parameter Name 2","value": "Parameter Value 2"}],
         "attachments":
        [{"name" : "image.png",
        "contentType" : "application.png",
        "content" : "BASE64ENCODING"}]
    }

    Query parameters
    messageId
    integer (int64)

    ID of the message

    recipientId
    integer (int64)

    ID of the user

    senderProfileName
    string

    TLS sender profile. Requires a Feature Switch and setting up 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 (messageId/recipientId) 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