RESTAPI
Page tree

Versions Compared

Old Version 4

changes.mady.by.user Api Documentation

Saved on

compared with

New Version Current

changes.mady.by.user Api Documentation

Saved on

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

Description

Returns a prepared message identified by the messageId, personalized for contactId

Available from

v14

Request path

GET [REST URL]/preparedmessage/get

Query Parameters

Parameter

Type

Description

messageId

Long

The prepared message ID

contactId

Long

empty

The contact ID to personalize message for. It has to be the member of the prepared message's group

emptyLeave contact empty to get not personalized (raw) message

Example response

Code Block
{
   "contactId": 45802709,
   "messageId": 7579,
   "name": "JohnPreparedWithCustom20220215",
   "groupId": 3302,
   "groupName": "John20220208",
   "selectionId": null,
   "selectionName": null,
   "channelId": 327699,
   "channelName": "DMC Email",
   "externalId": null,
   "messageCategoryId": null,
   "messageCategoryName": null,
   "message":    {
      "subject": "JohnPreparedWithCustom20220215",
      "emailBodyText": null,
      "emailBodyHtml": "<html><body>JohnPreparedWithCustom20220215\r\nEmail(standard) tt7177798@gmail.comtt7178198@gmail.com\r\nEmail(Custom) OBFUSCATEDtt71778198@gmail.com<\/body><\/html>",
      "smsText": null,
      "faxText": null,
      "emailHeaders": [],
      "attachments": [],
      "attachmentReferences": null,
      "encoding": "ISO-8859-1",
      "encodingSMS": "ISO-8859-1",
      "imageHandlingMode": "none"
   }
}

Error response

Code Block
{ ... "message": "Please enter a valid prepared message ID" ... }

Error response

Code Block
{ ... "message": "Please enter a valid test contact ID to get the personalized HTML. Leave it blank to get the raw HTML" ... }

Error response

Code Block
{ ... "message": "No membership for user '25493969' in group '2186' found.", ...}