Boomi MFT - File Sharing API Reference (1.16) - Message

Toggle Pane

• Message Service
  • postCreate New Message
  • getRetrieve Existing Message
  • delDelete Existing Message
  • putUpdate Message
  • putUpdate Discard Message
  • putUpdate Complete Message
  • getRetrieve SentThru List
  • postRetrieve Project Message Storage

API docs by Redocly

Download OpenAPI Specification: Download

Message Service

The Message REST Web Services provide endpoints for managing email messages within the system. These APIs enable the creation of new messages with specified parameters, the retrieval or updating of message details by ID, and the performance of message lifecycle operations, such as discarding or completing messages.

Create New Message

Creates MFT message according to ThruPublicMessageInfo structure passed in HTTP request

Remarks ToRecipients, CcRecipients, BccRecipients fields in ThruPublicMessageInfo should be present in request as a string array.
These fields will bind to required structure on server side.

DateExpired must be converted to UTC.

Invocation Scenarios

Send one or more files and folders to recipients Send private message to recipients

Remarks

All returned dates are in UTC.

Authorizations:

SessionAuth

Request Body schema: application/x-www-form-urlencoded

required

Request body — Request type: ThruPublicMessageInfo — Schema: ThruPublicMessageInfo structure contains information about MFT message.

CollectedFlag required	boolean Indicates does message were read at least by one of recipients
DateCreated required	string <date-time> Date and time when the message has been created (UTC)
DateExpired required	string <date-time> Date and time after which message is concerned as expired (UTC)
DateSent required	string <date-time> Date and time when the message has been sent (UTC)
ExpireNow required	boolean
IsExpired required	boolean Flag indicate is the message is expired
MessageID required	integer <int32> Unique identification number of the message
NotifyFlag required	boolean Flag that indicate is the notifications must be sent.
Priority required	integer <int32> 1 – High 2 – Low 3 – Normal
PrivateMessage required	string Text of the public part of the message
PublicMessage required	string Text of the private part of the message
RequestLogin required	boolean Flag that indicate is the message request login for access by recipient
SendByClient required	boolean Flag that indicate is the message was sent through the MFT Site or application.
Subject required	string Subject of the message
TrackingNo required	string Number over the message is registered in Thru
UserID required	integer <int32> Unique identification number of the user that is creator of message
MsgHtmlTemplate	string Html template over a message will be created
MsgTextTemplate	string Text template over a message will be created
	Array of objects (ThruPublicMessageRecipientInfo) List of recipient email addresses
	Array of objects (ThruPublicMessageRecipientInfo) List of Cc recipients
	Array of objects (ThruPublicMessageRecipientInfo) List of Bcc recipients
	Array of objects (ThruPublicFolderInfo) Collection of Folder identifiers
	Array of objects (ThruPublicFolderInfo) Collection of File identifiers

Responses

https://{MFTWebServer}/REST/{version}/Message

Request samples

• Payload

Content type

application/x-www-form-urlencoded

CollectedFlag=True&DateCreated=%2FDate%281337611985780%29%2F&DateExpired=%2FDate%281357070340000%29%2F&DateSent=%2FDate%281337611985780%29%2F&ExpireNow=False&IsExpired=False&MessageID=1HPHF1D8FF8S0&NotifyFlag=False&Priority=3&PrivateMessage=Private+text&PublicMessage=Public+text&RequestLogin=False&SendByClient=False&Subject=test&TrackingNo=T478-026-95732-36971&UserID=1Q1OBQWVHTROE&MsgHtmlTemplate=MsgHtmlTemplate&MsgTextTemplate=MsgTextTemplate&ToRecipients=%5B%7B%22Collected%22%3Atrue%2C%22MsgId%22%3A%221R6NE5OZ8QHXA%22%2C%22RecipientEmail%22%3A%22test.test%40test.com%22%2C%22RecipientId%22%3A%222MIMZFR1K0471%22%2C%22MsgRecipientLevelPublicID%22%3A%22MsgRecipientLevelPublicID%22%7D%5D&CcRecipients=%5B%7B%22Collected%22%3Atrue%2C%22MsgId%22%3A%221R6NE5OZ8QHXA%22%2C%22RecipientEmail%22%3A%22test.test%40test.com%22%2C%22RecipientId%22%3A%222MIMZFR1K0471%22%2C%22MsgRecipientLevelPublicID%22%3A%22MsgRecipientLevelPublicID%22%7D%5D&BccRecipients=%5B%7B%22Collected%22%3Atrue%2C%22MsgId%22%3A%221R6NE5OZ8QHXA%22%2C%22RecipientEmail%22%3A%22test.test%40test.com%22%2C%22RecipientId%22%3A%222MIMZFR1K0471%22%2C%22MsgRecipientLevelPublicID%22%3A%22MsgRecipientLevelPublicID%22%7D%5D&FoldersAttached=%5B%7B%22CreatedByUserID%22%3A%221Q1OBQWVHTROE%22%2C%22DateCreated%22%3A%22%2FDate%281337174868623%29%2F%22%2C%22DateModified%22%3A%22%2FDate%281337174868623%29%2F%22%2C%22EffectivePermission%22%3A254%2C%22FolderID%22%3A%220QN8H2VKTGIWE%22%2C%22FolderType%22%3A0%2C%22InFavorite%22%3Afalse%2C%22ModifiedByUserID%22%3A%221Q1OBQWVHTROE%22%2C%22Name%22%3A%22Admin%22%2C%22ParentFolderID%22%3A%2211ETULS0966VI%22%2C%22Path%22%3A%22FOLDERS%2FHOME%2FAdmin%22%2C%22Size%22%3A2450294218%2C%22Description%22%3A%22Description%22%2C%22Tags%22%3A%5B%22Tags%22%5D%7D%5D&FilesAttached=%5B%7B%22CreatedByUserID%22%3A%221Q1OBQWVHTROE%22%2C%22DateCreated%22%3A%22%2FDate%281337174868623%29%2F%22%2C%22DateModified%22%3A%22%2FDate%281337174868623%29%2F%22%2C%22EffectivePermission%22%3A254%2C%22FolderID%22%3A%220QN8H2VKTGIWE%22%2C%22FolderType%22%3A0%2C%22InFavorite%22%3Afalse%2C%22ModifiedByUserID%22%3A%221Q1OBQWVHTROE%22%2C%22Name%22%3A%22Admin%22%2C%22ParentFolderID%22%3A%2211ETULS0966VI%22%2C%22Path%22%3A%22FOLDERS%2FHOME%2FAdmin%22%2C%22Size%22%3A2450294218%2C%22Description%22%3A%22Description%22%2C%22Tags%22%3A%5B%22Tags%22%5D%7D%5D

Response samples

• 201

Content type

application/json

{

• "MessageID": "1HPHF1D8FF8S0",
• "UserID": "1Q1OBQWVHTROE",
• "Subject": "Test Subject",
• "DateCreated": "/Date(1337611985780)/",
• "DateSent": "/Date(1337611985780)/",
• "DateExpired": "/Date(1357070340000)/",
• "CollectedFlag": true,
• "PublicMessage": "Public text",
• "PrivateMessage": "Private text",
• "TrackingNo": "T478-026-95732-36971",
• "RequestLogin": false,
• "SendByClient": false,
• "NotifyFlag": false,
• "Priority": 3,
• "IsExpired": false,
• "ExpireNow": false,
• "MsgHtmlTemplate": "string",
• "MsgTextTemplate": "string",
• "ToRecipients": [

  • {

    • "MsgId": "1R6NE5OZ8QHXA",
    • "RecipientId": "2MIMZFR1K0471",
    • "RecipientEmail": "test.test@test.com",
    • "Collected": true,
    • "MsgRecipientLevelPublicID": "string"

    }

  ],
• "CcRecipients": [

  • {

    • "MsgId": "1R6NE5OZ8QHXA",
    • "RecipientId": "2MIMZFR1K0471",
    • "RecipientEmail": "test.test@test.com",
    • "Collected": true,
    • "MsgRecipientLevelPublicID": "string"

    }

  ],
• "BccRecipients": [

  • {

    • "MsgId": "1R6NE5OZ8QHXA",
    • "RecipientId": "2MIMZFR1K0471",
    • "RecipientEmail": "test.test@test.com",
    • "Collected": true,
    • "MsgRecipientLevelPublicID": "string"

    }

  ],
• "FoldersAttached": [

  • {

    • "FolderID": "0QN8H2VKTGIWE",
    • "ParentFolderID": "11ETULS0966VI",
    • "Name": "Admin",
    • "Path": "FOLDERS/HOME/Admin",
    • "Description": "string",
    • "Tags": [

      • "string"

      ],
    • "Size": 2450294218,
    • "EffectivePermission": 254,
    • "DateCreated": "/Date(1337174868623)/",
    • "DateModified": "/Date(1337174868623)/",
    • "CreatedByUserID": "1Q1OBQWVHTROE",
    • "ModifiedByUserID": "1Q1OBQWVHTROE",
    • "InFavorite": false,
    • "FolderType": 0

    }

  ],
• "FilesAttached": [

  • {

    • "FolderID": "0QN8H2VKTGIWE",
    • "ParentFolderID": "11ETULS0966VI",
    • "Name": "Admin",
    • "Path": "FOLDERS/HOME/Admin",
    • "Description": "string",
    • "Tags": [

      • "string"

      ],
    • "Size": 2450294218,
    • "EffectivePermission": 254,
    • "DateCreated": "/Date(1337174868623)/",
    • "DateModified": "/Date(1337174868623)/",
    • "CreatedByUserID": "1Q1OBQWVHTROE",
    • "ModifiedByUserID": "1Q1OBQWVHTROE",
    • "InFavorite": false,
    • "FolderType": 0

    }

  ]

}

Retrieve Existing Message

Retrieves message information based on the provided ID.

Remarks | All returned dates are in UTC. |

Authorizations:

SessionAuth

Responses

Response Schema: application/json

CollectedFlag required	boolean Indicates does message were read at least by one of recipients
DateCreated required	string <date-time> Date and time when the message has been created (UTC)
DateExpired required	string <date-time> Date and time after which message is concerned as expired (UTC)
DateSent required	string <date-time> Date and time when the message has been sent (UTC)
ExpireNow required	boolean
IsExpired required	boolean Flag indicate is the message is expired
MessageID required	integer <int32> Unique identification number of the message
NotifyFlag required	boolean Flag that indicate is the notifications must be sent.
Priority required	integer <int32> 1 – High 2 – Low 3 – Normal
PrivateMessage required	string Text of the public part of the message
PublicMessage required	string Text of the private part of the message
RequestLogin required	boolean Flag that indicate is the message request login for access by recipient
SendByClient required	boolean Flag that indicate is the message was sent through the MFT Site or application.
Subject required	string Subject of the message
TrackingNo required	string Number over the message is registered in Thru
UserID required	integer <int32> Unique identification number of the user that is creator of message
MsgHtmlTemplate	string Html template over a message will be created
MsgTextTemplate	string Text template over a message will be created
	Array of objects (ThruPublicMessageRecipientInfo) List of recipient email addresses
	Array of objects (ThruPublicMessageRecipientInfo) List of Cc recipients
	Array of objects (ThruPublicMessageRecipientInfo) List of Bcc recipients
	Array of objects (ThruPublicFolderInfo) Collection of Folder identifiers
	Array of objects (ThruPublicFolderInfo) Collection of File identifiers

https://{MFTWebServer}/REST/{version}/Message/{messageId}

Response samples

• 200

Content type

application/json

{

• "MessageID": "1HPHF1D8FF8S0",
• "UserID": "1Q1OBQWVHTROE",
• "Subject": "Test Subject",
• "DateCreated": "/Date(1337611985780)/",
• "DateSent": "/Date(1337611985780)/",
• "DateExpired": "/Date(1357070340000)/",
• "CollectedFlag": true,
• "PublicMessage": "Public text",
• "PrivateMessage": "Private text",
• "TrackingNo": "T478-026-95732-36971",
• "RequestLogin": false,
• "SendByClient": false,
• "NotifyFlag": false,
• "Priority": 3,
• "IsExpired": false,
• "ExpireNow": false,
• "MsgHtmlTemplate": "string",
• "MsgTextTemplate": "string",
• "ToRecipients": [

  • {

    • "MsgId": "1R6NE5OZ8QHXA",
    • "RecipientId": "2MIMZFR1K0471",
    • "RecipientEmail": "test.test@test.com",
    • "Collected": true,
    • "MsgRecipientLevelPublicID": "string"

    }

  ],
• "CcRecipients": [

  • {

    • "MsgId": "1R6NE5OZ8QHXA",
    • "RecipientId": "2MIMZFR1K0471",
    • "RecipientEmail": "test.test@test.com",
    • "Collected": true,
    • "MsgRecipientLevelPublicID": "string"

    }

  ],
• "BccRecipients": [

  • {

    • "MsgId": "1R6NE5OZ8QHXA",
    • "RecipientId": "2MIMZFR1K0471",
    • "RecipientEmail": "test.test@test.com",
    • "Collected": true,
    • "MsgRecipientLevelPublicID": "string"

    }

  ],
• "FoldersAttached": [

  • {

    • "FolderID": "0QN8H2VKTGIWE",
    • "ParentFolderID": "11ETULS0966VI",
    • "Name": "Admin",
    • "Path": "FOLDERS/HOME/Admin",
    • "Description": "string",
    • "Tags": [

      • "string"

      ],
    • "Size": 2450294218,
    • "EffectivePermission": 254,
    • "DateCreated": "/Date(1337174868623)/",
    • "DateModified": "/Date(1337174868623)/",
    • "CreatedByUserID": "1Q1OBQWVHTROE",
    • "ModifiedByUserID": "1Q1OBQWVHTROE",
    • "InFavorite": false,
    • "FolderType": 0

    }

  ],
• "FilesAttached": [

  • {

    • "FolderID": "0QN8H2VKTGIWE",
    • "ParentFolderID": "11ETULS0966VI",
    • "Name": "Admin",
    • "Path": "FOLDERS/HOME/Admin",
    • "Description": "string",
    • "Tags": [

      • "string"

      ],
    • "Size": 2450294218,
    • "EffectivePermission": 254,
    • "DateCreated": "/Date(1337174868623)/",
    • "DateModified": "/Date(1337174868623)/",
    • "CreatedByUserID": "1Q1OBQWVHTROE",
    • "ModifiedByUserID": "1Q1OBQWVHTROE",
    • "InFavorite": false,
    • "FolderType": 0

    }

  ]

}

Delete Existing Message

Deletes message based on the provided information. No additional data should be passed on the request body.

Authorizations:

SessionAuth

Responses

https://{MFTWebServer}/REST/{version}/Message/{messageId}

Update Message

Updates message information based on the provided information.
Information should be passed in the body as a serialized representation of the ThruPublicMessageInfo DTO

Remarks | Value of the MessageID field in the posted ThruPublicMessageInfo DTO should reference to the existing, non-deleted message. Otherwise, exception will be thrown.

Not all properties of ThruPublicMessageInfo can be modified:
DateExpired
ExpireNow
ToRecipients, CcRecipients, BccRecipients
FoldersAttached, FilesAttached

DateExpired must be converted to UTC.

Recipients to delete must be provided in ToRecipients field. They will be deleted from To, Cc and Bcc lists.

If provided, the values of the following fields are ignored:

Subject
Priority
PublicMessage
PrivateMessage
CollectedFlag
RequestLogin
SendByClient
DateCreated
DateSent

After successful processing of the command updated
ThruPublicFileInfo object will be returned.

Authorizations:

SessionAuth

Request Body schema: application/x-www-form-urlencoded

required

Request body — Request type: ThruPublicMessageInfo — Schema: ThruPublicMessageInfo structure contains information about MFT message.

CollectedFlag required	boolean Indicates does message were read at least by one of recipients
DateCreated required	string <date-time> Date and time when the message has been created (UTC)
DateExpired required	string <date-time> Date and time after which message is concerned as expired (UTC)
DateSent required	string <date-time> Date and time when the message has been sent (UTC)
ExpireNow required	boolean
IsExpired required	boolean Flag indicate is the message is expired
MessageID required	integer <int32> Unique identification number of the message
NotifyFlag required	boolean Flag that indicate is the notifications must be sent.
Priority required	integer <int32> 1 – High 2 – Low 3 – Normal
PrivateMessage required	string Text of the public part of the message
PublicMessage required	string Text of the private part of the message
RequestLogin required	boolean Flag that indicate is the message request login for access by recipient
SendByClient required	boolean Flag that indicate is the message was sent through the MFT Site or application.
Subject required	string Subject of the message
TrackingNo required	string Number over the message is registered in Thru
UserID required	integer <int32> Unique identification number of the user that is creator of message
MsgHtmlTemplate	string Html template over a message will be created
MsgTextTemplate	string Text template over a message will be created
	Array of objects (ThruPublicMessageRecipientInfo) List of recipient email addresses
	Array of objects (ThruPublicMessageRecipientInfo) List of Cc recipients
	Array of objects (ThruPublicMessageRecipientInfo) List of Bcc recipients
	Array of objects (ThruPublicFolderInfo) Collection of Folder identifiers
	Array of objects (ThruPublicFolderInfo) Collection of File identifiers

Responses

Response Schema: application/json

CollectedFlag required	boolean Indicates does message were read at least by one of recipients
DateCreated required	string <date-time> Date and time when the message has been created (UTC)
DateExpired required	string <date-time> Date and time after which message is concerned as expired (UTC)
DateSent required	string <date-time> Date and time when the message has been sent (UTC)
ExpireNow required	boolean
IsExpired required	boolean Flag indicate is the message is expired
MessageID required	integer <int32> Unique identification number of the message
NotifyFlag required	boolean Flag that indicate is the notifications must be sent.
Priority required	integer <int32> 1 – High 2 – Low 3 – Normal
PrivateMessage required	string Text of the public part of the message
PublicMessage required	string Text of the private part of the message
RequestLogin required	boolean Flag that indicate is the message request login for access by recipient
SendByClient required	boolean Flag that indicate is the message was sent through the MFT Site or application.
Subject required	string Subject of the message
TrackingNo required	string Number over the message is registered in Thru
UserID required	integer <int32> Unique identification number of the user that is creator of message
MsgHtmlTemplate	string Html template over a message will be created
MsgTextTemplate	string Text template over a message will be created
	Array of objects (ThruPublicMessageRecipientInfo) List of recipient email addresses
	Array of objects (ThruPublicMessageRecipientInfo) List of Cc recipients
	Array of objects (ThruPublicMessageRecipientInfo) List of Bcc recipients
	Array of objects (ThruPublicFolderInfo) Collection of Folder identifiers
	Array of objects (ThruPublicFolderInfo) Collection of File identifiers

https://{MFTWebServer}/REST/{version}/Message/{messageId}

Request samples

• Payload

Content type

application/x-www-form-urlencoded

CollectedFlag=True&DateCreated=%2FDate%281337611985780%29%2F&DateExpired=%2FDate%281357070340000%29%2F&DateSent=%2FDate%281337611985780%29%2F&ExpireNow=False&IsExpired=False&MessageID=1HPHF1D8FF8S0&NotifyFlag=False&Priority=3&PrivateMessage=Private+text&PublicMessage=Public+text&RequestLogin=False&SendByClient=False&Subject=test&TrackingNo=T478-026-95732-36971&UserID=1Q1OBQWVHTROE&MsgHtmlTemplate=MsgHtmlTemplate&MsgTextTemplate=MsgTextTemplate&ToRecipients=%5B%7B%22Collected%22%3Atrue%2C%22MsgId%22%3A%221R6NE5OZ8QHXA%22%2C%22RecipientEmail%22%3A%22test.test%40test.com%22%2C%22RecipientId%22%3A%222MIMZFR1K0471%22%2C%22MsgRecipientLevelPublicID%22%3A%22MsgRecipientLevelPublicID%22%7D%5D&CcRecipients=%5B%7B%22Collected%22%3Atrue%2C%22MsgId%22%3A%221R6NE5OZ8QHXA%22%2C%22RecipientEmail%22%3A%22test.test%40test.com%22%2C%22RecipientId%22%3A%222MIMZFR1K0471%22%2C%22MsgRecipientLevelPublicID%22%3A%22MsgRecipientLevelPublicID%22%7D%5D&BccRecipients=%5B%7B%22Collected%22%3Atrue%2C%22MsgId%22%3A%221R6NE5OZ8QHXA%22%2C%22RecipientEmail%22%3A%22test.test%40test.com%22%2C%22RecipientId%22%3A%222MIMZFR1K0471%22%2C%22MsgRecipientLevelPublicID%22%3A%22MsgRecipientLevelPublicID%22%7D%5D&FoldersAttached=%5B%7B%22CreatedByUserID%22%3A%221Q1OBQWVHTROE%22%2C%22DateCreated%22%3A%22%2FDate%281337174868623%29%2F%22%2C%22DateModified%22%3A%22%2FDate%281337174868623%29%2F%22%2C%22EffectivePermission%22%3A254%2C%22FolderID%22%3A%220QN8H2VKTGIWE%22%2C%22FolderType%22%3A0%2C%22InFavorite%22%3Afalse%2C%22ModifiedByUserID%22%3A%221Q1OBQWVHTROE%22%2C%22Name%22%3A%22Admin%22%2C%22ParentFolderID%22%3A%2211ETULS0966VI%22%2C%22Path%22%3A%22FOLDERS%2FHOME%2FAdmin%22%2C%22Size%22%3A2450294218%2C%22Description%22%3A%22Description%22%2C%22Tags%22%3A%5B%22Tags%22%5D%7D%5D&FilesAttached=%5B%7B%22CreatedByUserID%22%3A%221Q1OBQWVHTROE%22%2C%22DateCreated%22%3A%22%2FDate%281337174868623%29%2F%22%2C%22DateModified%22%3A%22%2FDate%281337174868623%29%2F%22%2C%22EffectivePermission%22%3A254%2C%22FolderID%22%3A%220QN8H2VKTGIWE%22%2C%22FolderType%22%3A0%2C%22InFavorite%22%3Afalse%2C%22ModifiedByUserID%22%3A%221Q1OBQWVHTROE%22%2C%22Name%22%3A%22Admin%22%2C%22ParentFolderID%22%3A%2211ETULS0966VI%22%2C%22Path%22%3A%22FOLDERS%2FHOME%2FAdmin%22%2C%22Size%22%3A2450294218%2C%22Description%22%3A%22Description%22%2C%22Tags%22%3A%5B%22Tags%22%5D%7D%5D

Response samples

• 200

Content type

application/json

{

• "MessageID": "1HPHF1D8FF8S0",
• "UserID": "1Q1OBQWVHTROE",
• "Subject": "Test Subject",
• "DateCreated": "/Date(1337611985780)/",
• "DateSent": "/Date(1337611985780)/",
• "DateExpired": "/Date(1357070340000)/",
• "CollectedFlag": true,
• "PublicMessage": "Public text",
• "PrivateMessage": "Private text",
• "TrackingNo": "T478-026-95732-36971",
• "RequestLogin": false,
• "SendByClient": false,
• "NotifyFlag": false,
• "Priority": 3,
• "IsExpired": false,
• "ExpireNow": false,
• "MsgHtmlTemplate": "string",
• "MsgTextTemplate": "string",
• "ToRecipients": [

  • {

    • "MsgId": "1R6NE5OZ8QHXA",
    • "RecipientId": "2MIMZFR1K0471",
    • "RecipientEmail": "test.test@test.com",
    • "Collected": true,
    • "MsgRecipientLevelPublicID": "string"

    }

  ],
• "CcRecipients": [

  • {

    • "MsgId": "1R6NE5OZ8QHXA",
    • "RecipientId": "2MIMZFR1K0471",
    • "RecipientEmail": "test.test@test.com",
    • "Collected": true,
    • "MsgRecipientLevelPublicID": "string"

    }

  ],
• "BccRecipients": [

  • {

    • "MsgId": "1R6NE5OZ8QHXA",
    • "RecipientId": "2MIMZFR1K0471",
    • "RecipientEmail": "test.test@test.com",
    • "Collected": true,
    • "MsgRecipientLevelPublicID": "string"

    }

  ],
• "FoldersAttached": [

  • {

    • "FolderID": "0QN8H2VKTGIWE",
    • "ParentFolderID": "11ETULS0966VI",
    • "Name": "Admin",
    • "Path": "FOLDERS/HOME/Admin",
    • "Description": "string",
    • "Tags": [

      • "string"

      ],
    • "Size": 2450294218,
    • "EffectivePermission": 254,
    • "DateCreated": "/Date(1337174868623)/",
    • "DateModified": "/Date(1337174868623)/",
    • "CreatedByUserID": "1Q1OBQWVHTROE",
    • "ModifiedByUserID": "1Q1OBQWVHTROE",
    • "InFavorite": false,
    • "FolderType": 0

    }

  ],
• "FilesAttached": [

  • {

    • "FolderID": "0QN8H2VKTGIWE",
    • "ParentFolderID": "11ETULS0966VI",
    • "Name": "Admin",
    • "Path": "FOLDERS/HOME/Admin",
    • "Description": "string",
    • "Tags": [

      • "string"

      ],
    • "Size": 2450294218,
    • "EffectivePermission": 254,
    • "DateCreated": "/Date(1337174868623)/",
    • "DateModified": "/Date(1337174868623)/",
    • "CreatedByUserID": "1Q1OBQWVHTROE",
    • "ModifiedByUserID": "1Q1OBQWVHTROE",
    • "InFavorite": false,
    • "FolderType": 0

    }

  ]

}

Update Discard Message

Discard message based on the provided information. No additional data should be passed on the request body.

Remarks | This method can be called only after the method ‘New MFT message’ is called |

Authorizations:

SessionAuth

Responses

https://{MFTWebServer}/REST/{version}/Message/Discard/{messageId}

Update Complete Message

Complete message based on the provided information. No additional data should be passed on the request body.

Remarks | This method can be called only after the method ‘New MFT message’ is called |

Authorizations:

SessionAuth

Responses

Response Schema: application/json

CollectedFlag required	boolean Indicates does message were read at least by one of recipients
DateCreated required	string <date-time> Date and time when the message has been created (UTC)
DateExpired required	string <date-time> Date and time after which message is concerned as expired (UTC)
DateSent required	string <date-time> Date and time when the message has been sent (UTC)
ExpireNow required	boolean
IsExpired required	boolean Flag indicate is the message is expired
MessageID required	integer <int32> Unique identification number of the message
NotifyFlag required	boolean Flag that indicate is the notifications must be sent.
Priority required	integer <int32> 1 – High 2 – Low 3 – Normal
PrivateMessage required	string Text of the public part of the message
PublicMessage required	string Text of the private part of the message
RequestLogin required	boolean Flag that indicate is the message request login for access by recipient
SendByClient required	boolean Flag that indicate is the message was sent through the MFT Site or application.
Subject required	string Subject of the message
TrackingNo required	string Number over the message is registered in Thru
UserID required	integer <int32> Unique identification number of the user that is creator of message
MsgHtmlTemplate	string Html template over a message will be created
MsgTextTemplate	string Text template over a message will be created
	Array of objects (ThruPublicMessageRecipientInfo) List of recipient email addresses
	Array of objects (ThruPublicMessageRecipientInfo) List of Cc recipients
	Array of objects (ThruPublicMessageRecipientInfo) List of Bcc recipients
	Array of objects (ThruPublicFolderInfo) Collection of Folder identifiers
	Array of objects (ThruPublicFolderInfo) Collection of File identifiers

https://{MFTWebServer}/REST/{version}/Message/Complete/{messageId}

Response samples

• 200

Content type

application/json

{

• "MessageID": "1HPHF1D8FF8S0",
• "UserID": "1Q1OBQWVHTROE",
• "Subject": "Test Subject",
• "DateCreated": "/Date(1337611985780)/",
• "DateSent": "/Date(1337611985780)/",
• "DateExpired": "/Date(1357070340000)/",
• "CollectedFlag": true,
• "PublicMessage": "Public text",
• "PrivateMessage": "Private text",
• "TrackingNo": "T478-026-95732-36971",
• "RequestLogin": false,
• "SendByClient": false,
• "NotifyFlag": false,
• "Priority": 3,
• "IsExpired": false,
• "ExpireNow": false,
• "MsgHtmlTemplate": "string",
• "MsgTextTemplate": "string",
• "ToRecipients": [

  • {

    • "MsgId": "1R6NE5OZ8QHXA",
    • "RecipientId": "2MIMZFR1K0471",
    • "RecipientEmail": "test.test@test.com",
    • "Collected": true,
    • "MsgRecipientLevelPublicID": "string"

    }

  ],
• "CcRecipients": [

  • {

    • "MsgId": "1R6NE5OZ8QHXA",
    • "RecipientId": "2MIMZFR1K0471",
    • "RecipientEmail": "test.test@test.com",
    • "Collected": true,
    • "MsgRecipientLevelPublicID": "string"

    }

  ],
• "BccRecipients": [

  • {

    • "MsgId": "1R6NE5OZ8QHXA",
    • "RecipientId": "2MIMZFR1K0471",
    • "RecipientEmail": "test.test@test.com",
    • "Collected": true,
    • "MsgRecipientLevelPublicID": "string"

    }

  ],
• "FoldersAttached": [

  • {

    • "FolderID": "0QN8H2VKTGIWE",
    • "ParentFolderID": "11ETULS0966VI",
    • "Name": "Admin",
    • "Path": "FOLDERS/HOME/Admin",
    • "Description": "string",
    • "Tags": [

      • "string"

      ],
    • "Size": 2450294218,
    • "EffectivePermission": 254,
    • "DateCreated": "/Date(1337174868623)/",
    • "DateModified": "/Date(1337174868623)/",
    • "CreatedByUserID": "1Q1OBQWVHTROE",
    • "ModifiedByUserID": "1Q1OBQWVHTROE",
    • "InFavorite": false,
    • "FolderType": 0

    }

  ],
• "FilesAttached": [

  • {

    • "FolderID": "0QN8H2VKTGIWE",
    • "ParentFolderID": "11ETULS0966VI",
    • "Name": "Admin",
    • "Path": "FOLDERS/HOME/Admin",
    • "Description": "string",
    • "Tags": [

      • "string"

      ],
    • "Size": 2450294218,
    • "EffectivePermission": 254,
    • "DateCreated": "/Date(1337174868623)/",
    • "DateModified": "/Date(1337174868623)/",
    • "CreatedByUserID": "1Q1OBQWVHTROE",
    • "ModifiedByUserID": "1Q1OBQWVHTROE",
    • "InFavorite": false,
    • "FolderType": 0

    }

  ]

}

Retrieve SentThru List

Get list of the sent messages. Attachments are not included in returned data object.

Authorizations:

SessionAuth

Responses

Response Schema: application/json

CollectedFlag required	boolean Indicates does message were read at least by one of recipients
DateCreated required	string <date-time> Date and time when the message has been created (UTC)
DateExpired required	string <date-time> Date and time after which message is concerned as expired (UTC)
DateSent required	string <date-time> Date and time when the message has been sent (UTC)
ExpireNow required	boolean
IsExpired required	boolean Flag indicate is the message is expired
MessageID required	integer <int32> Unique identification number of the message
NotifyFlag required	boolean Flag that indicate is the notifications must be sent.
Priority required	integer <int32> 1 – High 2 – Low 3 – Normal
PrivateMessage required	string Text of the public part of the message
PublicMessage required	string Text of the private part of the message
RequestLogin required	boolean Flag that indicate is the message request login for access by recipient
SendByClient required	boolean Flag that indicate is the message was sent through the MFT Site or application.
Subject required	string Subject of the message
TrackingNo required	string Number over the message is registered in Thru
UserID required	integer <int32> Unique identification number of the user that is creator of message
MsgHtmlTemplate	string Html template over a message will be created
MsgTextTemplate	string Text template over a message will be created
	Array of objects (ThruPublicMessageRecipientInfo) List of recipient email addresses
	Array of objects (ThruPublicMessageRecipientInfo) List of Cc recipients
	Array of objects (ThruPublicMessageRecipientInfo) List of Bcc recipients
	Array of objects (ThruPublicFolderInfo) Collection of Folder identifiers
	Array of objects (ThruPublicFolderInfo) Collection of File identifiers

https://{MFTWebServer}/REST/{version}/Message/Content/{skip}/{take}

Response samples

• 200

Content type

application/json

{

• "MessageID": "1HPHF1D8FF8S0",
• "UserID": "1Q1OBQWVHTROE",
• "Subject": "Test Subject",
• "DateCreated": "/Date(1337611985780)/",
• "DateSent": "/Date(1337611985780)/",
• "DateExpired": "/Date(1357070340000)/",
• "CollectedFlag": true,
• "PublicMessage": "Public text",
• "PrivateMessage": "Private text",
• "TrackingNo": "T478-026-95732-36971",
• "RequestLogin": false,
• "SendByClient": false,
• "NotifyFlag": false,
• "Priority": 3,
• "IsExpired": false,
• "ExpireNow": false,
• "MsgHtmlTemplate": "string",
• "MsgTextTemplate": "string",
• "ToRecipients": [

  • {

    • "MsgId": "1R6NE5OZ8QHXA",
    • "RecipientId": "2MIMZFR1K0471",
    • "RecipientEmail": "test.test@test.com",
    • "Collected": true,
    • "MsgRecipientLevelPublicID": "string"

    }

  ],
• "CcRecipients": [

  • {

    • "MsgId": "1R6NE5OZ8QHXA",
    • "RecipientId": "2MIMZFR1K0471",
    • "RecipientEmail": "test.test@test.com",
    • "Collected": true,
    • "MsgRecipientLevelPublicID": "string"

    }

  ],
• "BccRecipients": [

  • {

    • "MsgId": "1R6NE5OZ8QHXA",
    • "RecipientId": "2MIMZFR1K0471",
    • "RecipientEmail": "test.test@test.com",
    • "Collected": true,
    • "MsgRecipientLevelPublicID": "string"

    }

  ],
• "FoldersAttached": [

  • {

    • "FolderID": "0QN8H2VKTGIWE",
    • "ParentFolderID": "11ETULS0966VI",
    • "Name": "Admin",
    • "Path": "FOLDERS/HOME/Admin",
    • "Description": "string",
    • "Tags": [

      • "string"

      ],
    • "Size": 2450294218,
    • "EffectivePermission": 254,
    • "DateCreated": "/Date(1337174868623)/",
    • "DateModified": "/Date(1337174868623)/",
    • "CreatedByUserID": "1Q1OBQWVHTROE",
    • "ModifiedByUserID": "1Q1OBQWVHTROE",
    • "InFavorite": false,
    • "FolderType": 0

    }

  ],
• "FilesAttached": [

  • {

    • "FolderID": "0QN8H2VKTGIWE",
    • "ParentFolderID": "11ETULS0966VI",
    • "Name": "Admin",
    • "Path": "FOLDERS/HOME/Admin",
    • "Description": "string",
    • "Tags": [

      • "string"

      ],
    • "Size": 2450294218,
    • "EffectivePermission": 254,
    • "DateCreated": "/Date(1337174868623)/",
    • "DateModified": "/Date(1337174868623)/",
    • "CreatedByUserID": "1Q1OBQWVHTROE",
    • "ModifiedByUserID": "1Q1OBQWVHTROE",
    • "InFavorite": false,
    • "FolderType": 0

    }

  ]

}

Retrieve Project Message Storage

Retrieves a folder information of the message storage.

Authorizations:

SessionAuth

Request Body schema: application/x-www-form-urlencoded

required

Request body — Request type: object

Subject required

string The subject text

Responses

https://{MFTWebServer}/REST/{version}/Message/Storage/{type}

Request samples

• Payload

Content type

application/x-www-form-urlencoded

Subject=Test%20Subject

Response samples

• 201

Content type

application/json

{

• "MessageID": "1HPHF1D8FF8S0",
• "UserID": "1Q1OBQWVHTROE",
• "Subject": "Test Subject",
• "DateCreated": "/Date(1337611985780)/",
• "DateSent": "/Date(1337611985780)/",
• "DateExpired": "/Date(1357070340000)/",
• "CollectedFlag": true,
• "PublicMessage": "Public text",
• "PrivateMessage": "Private text",
• "TrackingNo": "T478-026-95732-36971",
• "RequestLogin": false,
• "SendByClient": false,
• "NotifyFlag": false,
• "Priority": 3,
• "IsExpired": false,
• "ExpireNow": false,
• "MsgHtmlTemplate": "string",
• "MsgTextTemplate": "string",
• "ToRecipients": [

  • {

    • "MsgId": "1R6NE5OZ8QHXA",
    • "RecipientId": "2MIMZFR1K0471",
    • "RecipientEmail": "test.test@test.com",
    • "Collected": true,
    • "MsgRecipientLevelPublicID": "string"

    }

  ],
• "CcRecipients": [

  • {

    • "MsgId": "1R6NE5OZ8QHXA",
    • "RecipientId": "2MIMZFR1K0471",
    • "RecipientEmail": "test.test@test.com",
    • "Collected": true,
    • "MsgRecipientLevelPublicID": "string"

    }

  ],
• "BccRecipients": [

  • {

    • "MsgId": "1R6NE5OZ8QHXA",
    • "RecipientId": "2MIMZFR1K0471",
    • "RecipientEmail": "test.test@test.com",
    • "Collected": true,
    • "MsgRecipientLevelPublicID": "string"

    }

  ],
• "FoldersAttached": [

  • {

    • "FolderID": "0QN8H2VKTGIWE",
    • "ParentFolderID": "11ETULS0966VI",
    • "Name": "Admin",
    • "Path": "FOLDERS/HOME/Admin",
    • "Description": "string",
    • "Tags": [

      • "string"

      ],
    • "Size": 2450294218,
    • "EffectivePermission": 254,
    • "DateCreated": "/Date(1337174868623)/",
    • "DateModified": "/Date(1337174868623)/",
    • "CreatedByUserID": "1Q1OBQWVHTROE",
    • "ModifiedByUserID": "1Q1OBQWVHTROE",
    • "InFavorite": false,
    • "FolderType": 0

    }

  ],
• "FilesAttached": [

  • {

    • "FolderID": "0QN8H2VKTGIWE",
    • "ParentFolderID": "11ETULS0966VI",
    • "Name": "Admin",
    • "Path": "FOLDERS/HOME/Admin",
    • "Description": "string",
    • "Tags": [

      • "string"

      ],
    • "Size": 2450294218,
    • "EffectivePermission": 254,
    • "DateCreated": "/Date(1337174868623)/",
    • "DateModified": "/Date(1337174868623)/",
    • "CreatedByUserID": "1Q1OBQWVHTROE",
    • "ModifiedByUserID": "1Q1OBQWVHTROE",
    • "InFavorite": false,
    • "FolderType": 0

    }

  ]

}