POST api/v2/samples/methods/{sampleMethodId}/messages

Request

URI Parameters

NameDescriptionTypeAdditional information
sampleMethodId

integer

Required

Body Parameters

MessageNew
NameDescriptionTypeAdditional information
Active

boolean

Subject

string

MessageID

string

Folder

string

EmailFrom

string

Sent

date

SentExternal

date

AccountFromId

integer

MessageTypeId

integer

MessageHtml

string

MessageTextPlan

string

Draft

boolean

Urgent

boolean

Files

Collection of FileNew

Recipients

Object

Request Formats

application/json, text/json

Sample:
{
  "Active": true,
  "Subject": "sample string 2",
  "MessageID": "sample string 3",
  "Folder": "sample string 4",
  "EmailFrom": "sample string 5",
  "Sent": "2025-08-04T18:41:02.6351374Z",
  "SentExternal": "2025-08-04T18:41:02.6351374Z",
  "AccountFromId": 1,
  "MessageTypeId": 1,
  "MessageHtml": "sample string 6",
  "MessageTextPlan": "sample string 7",
  "Draft": true,
  "Urgent": true,
  "Files": [
    {
      "Identification": "sample string 1",
      "Category": "sample string 2",
      "FileData": "QEA=",
      "Path": "sample string 3",
      "Version": 1,
      "DisplayVersion": "sample string 4",
      "DeleteOn": "2025-08-04T18:41:02.6361335Z",
      "DownloadForUserId": 1,
      "AllowDownload": true,
      "MustStayOnDB": true,
      "AutomaticGeneration": true
    },
    {
      "Identification": "sample string 1",
      "Category": "sample string 2",
      "FileData": "QEA=",
      "Path": "sample string 3",
      "Version": 1,
      "DisplayVersion": "sample string 4",
      "DeleteOn": "2025-08-04T18:41:02.6361335Z",
      "DownloadForUserId": 1,
      "AllowDownload": true,
      "MustStayOnDB": true,
      "AutomaticGeneration": true
    }
  ],
  "Recipients": {}
}

text/html

Sample:
{"Active":true,"Subject":"sample string 2","MessageID":"sample string 3","Folder":"sample string 4","EmailFrom":"sample string 5","Sent":"2025-08-04T18:41:02.6351374Z","SentExternal":"2025-08-04T18:41:02.6351374Z","AccountFromId":1,"MessageTypeId":1,"MessageHtml":"sample string 6","MessageTextPlan":"sample string 7","Draft":true,"Urgent":true,"Files":[{"Identification":"sample string 1","Category":"sample string 2","FileData":"QEA=","Path":"sample string 3","Version":1,"DisplayVersion":"sample string 4","DeleteOn":"2025-08-04T18:41:02.6361335Z","DownloadForUserId":1,"AllowDownload":true,"MustStayOnDB":true,"AutomaticGeneration":true},{"Identification":"sample string 1","Category":"sample string 2","FileData":"QEA=","Path":"sample string 3","Version":1,"DisplayVersion":"sample string 4","DeleteOn":"2025-08-04T18:41:02.6361335Z","DownloadForUserId":1,"AllowDownload":true,"MustStayOnDB":true,"AutomaticGeneration":true}],"Recipients":{}}

Response

Collection of integer

Response Format

application/json, text/json

Sample:
[
  1,
  2
]

text/html

Sample:
[1,2]