Put Shipment Message Entity

using RestSharp;


var options = new RestClientOptions("http://localhost:56350/api/v1/ShipmentMessage/{id}");
var client = new RestClient(options);
var request = new RestRequest("");
request.AddJsonBody("{\n  \"ShipmentMessageId\": 123,\n  \"PlainMessage\": \"<string>\",\n  \"HtmlMessage\": \"<string>\",\n  \"SmsMessage\": \"<string>\",\n  \"Description\": \"<string>\",\n  \"Subject\": \"<string>\",\n  \"FolderId\": 123,\n  \"HeaderField\": \"<string>\",\n  \"Design\": \"<string>\",\n  \"RegisterViews\": true,\n  \"InlineImages\": true,\n  \"LongDescription\": \"<string>\",\n  \"AccessKey\": \"<string>\",\n  \"DocumentMessage\": 123,\n  \"Registered\": \"2023-11-07T05:31:56Z\",\n  \"RegisteredAssociateId\": 123,\n  \"Updated\": \"2023-11-07T05:31:56Z\",\n  \"UpdatedAssociateId\": 123,\n  \"UpdatedCount\": 123,\n  \"TableRight\": {\n    \"Mask\": \"<string>\",\n    \"Reason\": \"<string>\"\n  },\n  \"FieldProperties\": {}\n}", false);
var response = await client.PutAsync(request);

Console.WriteLine("{0}", response.Content);

const options = {
  method: 'PUT',
  headers: {'Content-Type': 'application/json'},
  body: JSON.stringify({
    ShipmentMessageId: 123,
    PlainMessage: '<string>',
    HtmlMessage: '<string>',
    SmsMessage: '<string>',
    Description: '<string>',
    Subject: '<string>',
    FolderId: 123,
    HeaderField: '<string>',
    Design: '<string>',
    RegisterViews: true,
    InlineImages: true,
    LongDescription: '<string>',
    AccessKey: '<string>',
    DocumentMessage: 123,
    Registered: '2023-11-07T05:31:56Z',
    RegisteredAssociateId: 123,
    Updated: '2023-11-07T05:31:56Z',
    UpdatedAssociateId: 123,
    UpdatedCount: 123,
    TableRight: {Mask: '<string>', Reason: '<string>'},
    FieldProperties: {}
  })
};

fetch('http://localhost:56350/api/v1/ShipmentMessage/{id}', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_PORT => "56350",
  CURLOPT_URL => "http://localhost:56350/api/v1/ShipmentMessage/{id}",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "PUT",
  CURLOPT_POSTFIELDS => json_encode([
    'ShipmentMessageId' => 123,
    'PlainMessage' => '<string>',
    'HtmlMessage' => '<string>',
    'SmsMessage' => '<string>',
    'Description' => '<string>',
    'Subject' => '<string>',
    'FolderId' => 123,
    'HeaderField' => '<string>',
    'Design' => '<string>',
    'RegisterViews' => true,
    'InlineImages' => true,
    'LongDescription' => '<string>',
    'AccessKey' => '<string>',
    'DocumentMessage' => 123,
    'Registered' => '2023-11-07T05:31:56Z',
    'RegisteredAssociateId' => 123,
    'Updated' => '2023-11-07T05:31:56Z',
    'UpdatedAssociateId' => 123,
    'UpdatedCount' => 123,
    'TableRight' => [
        'Mask' => '<string>',
        'Reason' => '<string>'
    ],
    'FieldProperties' => [
        
    ]
  ]),
  CURLOPT_HTTPHEADER => [
    "Content-Type: application/json"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

import requests

url = "http://localhost:56350/api/v1/ShipmentMessage/{id}"

payload = {
    "ShipmentMessageId": 123,
    "PlainMessage": "<string>",
    "HtmlMessage": "<string>",
    "SmsMessage": "<string>",
    "Description": "<string>",
    "Subject": "<string>",
    "FolderId": 123,
    "HeaderField": "<string>",
    "Design": "<string>",
    "RegisterViews": True,
    "InlineImages": True,
    "LongDescription": "<string>",
    "AccessKey": "<string>",
    "DocumentMessage": 123,
    "Registered": "2023-11-07T05:31:56Z",
    "RegisteredAssociateId": 123,
    "Updated": "2023-11-07T05:31:56Z",
    "UpdatedAssociateId": 123,
    "UpdatedCount": 123,
    "TableRight": {
        "Mask": "<string>",
        "Reason": "<string>"
    },
    "FieldProperties": {}
}
headers = {"Content-Type": "application/json"}

response = requests.put(url, json=payload, headers=headers)

print(response.text)

const options = {
  method: 'PUT',
  headers: {'Content-Type': 'application/json'},
  body: JSON.stringify({
    ShipmentMessageId: 123,
    PlainMessage: '<string>',
    HtmlMessage: '<string>',
    SmsMessage: '<string>',
    Description: '<string>',
    Subject: '<string>',
    FolderId: 123,
    HeaderField: '<string>',
    Design: '<string>',
    RegisterViews: true,
    InlineImages: true,
    LongDescription: '<string>',
    AccessKey: '<string>',
    DocumentMessage: 123,
    Registered: '2023-11-07T05:31:56Z',
    RegisteredAssociateId: 123,
    Updated: '2023-11-07T05:31:56Z',
    UpdatedAssociateId: 123,
    UpdatedCount: 123,
    TableRight: {Mask: '<string>', Reason: '<string>'},
    FieldProperties: {}
  })
};

fetch('http://localhost:56350/api/v1/ShipmentMessage/{id}', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

{
  "ShipmentMessageId": 123,
  "PlainMessage": "<string>",
  "HtmlMessage": "<string>",
  "SmsMessage": "<string>",
  "Description": "<string>",
  "Subject": "<string>",
  "FolderId": 123,
  "HeaderField": "<string>",
  "Design": "<string>",
  "Designtype": "Unknown",
  "Flags": "Plain",
  "RegisterViews": true,
  "InlineImages": true,
  "LongDescription": "<string>",
  "AccessKey": "<string>",
  "DocumentMessage": 123,
  "Registered": "2023-11-07T05:31:56Z",
  "RegisteredAssociateId": 123,
  "Updated": "2023-11-07T05:31:56Z",
  "UpdatedAssociateId": 123,
  "UpdatedCount": 123,
  "TableRight": {
    "Mask": "<string>",
    "Reason": "<string>"
  },
  "FieldProperties": {},
  "_Links": {}
}

Put Shipment Message Entity

using RestSharp;


var options = new RestClientOptions("http://localhost:56350/api/v1/ShipmentMessage/{id}");
var client = new RestClient(options);
var request = new RestRequest("");
request.AddJsonBody("{\n  \"ShipmentMessageId\": 123,\n  \"PlainMessage\": \"<string>\",\n  \"HtmlMessage\": \"<string>\",\n  \"SmsMessage\": \"<string>\",\n  \"Description\": \"<string>\",\n  \"Subject\": \"<string>\",\n  \"FolderId\": 123,\n  \"HeaderField\": \"<string>\",\n  \"Design\": \"<string>\",\n  \"RegisterViews\": true,\n  \"InlineImages\": true,\n  \"LongDescription\": \"<string>\",\n  \"AccessKey\": \"<string>\",\n  \"DocumentMessage\": 123,\n  \"Registered\": \"2023-11-07T05:31:56Z\",\n  \"RegisteredAssociateId\": 123,\n  \"Updated\": \"2023-11-07T05:31:56Z\",\n  \"UpdatedAssociateId\": 123,\n  \"UpdatedCount\": 123,\n  \"TableRight\": {\n    \"Mask\": \"<string>\",\n    \"Reason\": \"<string>\"\n  },\n  \"FieldProperties\": {}\n}", false);
var response = await client.PutAsync(request);

Console.WriteLine("{0}", response.Content);

const options = {
  method: 'PUT',
  headers: {'Content-Type': 'application/json'},
  body: JSON.stringify({
    ShipmentMessageId: 123,
    PlainMessage: '<string>',
    HtmlMessage: '<string>',
    SmsMessage: '<string>',
    Description: '<string>',
    Subject: '<string>',
    FolderId: 123,
    HeaderField: '<string>',
    Design: '<string>',
    RegisterViews: true,
    InlineImages: true,
    LongDescription: '<string>',
    AccessKey: '<string>',
    DocumentMessage: 123,
    Registered: '2023-11-07T05:31:56Z',
    RegisteredAssociateId: 123,
    Updated: '2023-11-07T05:31:56Z',
    UpdatedAssociateId: 123,
    UpdatedCount: 123,
    TableRight: {Mask: '<string>', Reason: '<string>'},
    FieldProperties: {}
  })
};

fetch('http://localhost:56350/api/v1/ShipmentMessage/{id}', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_PORT => "56350",
  CURLOPT_URL => "http://localhost:56350/api/v1/ShipmentMessage/{id}",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "PUT",
  CURLOPT_POSTFIELDS => json_encode([
    'ShipmentMessageId' => 123,
    'PlainMessage' => '<string>',
    'HtmlMessage' => '<string>',
    'SmsMessage' => '<string>',
    'Description' => '<string>',
    'Subject' => '<string>',
    'FolderId' => 123,
    'HeaderField' => '<string>',
    'Design' => '<string>',
    'RegisterViews' => true,
    'InlineImages' => true,
    'LongDescription' => '<string>',
    'AccessKey' => '<string>',
    'DocumentMessage' => 123,
    'Registered' => '2023-11-07T05:31:56Z',
    'RegisteredAssociateId' => 123,
    'Updated' => '2023-11-07T05:31:56Z',
    'UpdatedAssociateId' => 123,
    'UpdatedCount' => 123,
    'TableRight' => [
        'Mask' => '<string>',
        'Reason' => '<string>'
    ],
    'FieldProperties' => [
        
    ]
  ]),
  CURLOPT_HTTPHEADER => [
    "Content-Type: application/json"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

import requests

url = "http://localhost:56350/api/v1/ShipmentMessage/{id}"

payload = {
    "ShipmentMessageId": 123,
    "PlainMessage": "<string>",
    "HtmlMessage": "<string>",
    "SmsMessage": "<string>",
    "Description": "<string>",
    "Subject": "<string>",
    "FolderId": 123,
    "HeaderField": "<string>",
    "Design": "<string>",
    "RegisterViews": True,
    "InlineImages": True,
    "LongDescription": "<string>",
    "AccessKey": "<string>",
    "DocumentMessage": 123,
    "Registered": "2023-11-07T05:31:56Z",
    "RegisteredAssociateId": 123,
    "Updated": "2023-11-07T05:31:56Z",
    "UpdatedAssociateId": 123,
    "UpdatedCount": 123,
    "TableRight": {
        "Mask": "<string>",
        "Reason": "<string>"
    },
    "FieldProperties": {}
}
headers = {"Content-Type": "application/json"}

response = requests.put(url, json=payload, headers=headers)

print(response.text)

const options = {
  method: 'PUT',
  headers: {'Content-Type': 'application/json'},
  body: JSON.stringify({
    ShipmentMessageId: 123,
    PlainMessage: '<string>',
    HtmlMessage: '<string>',
    SmsMessage: '<string>',
    Description: '<string>',
    Subject: '<string>',
    FolderId: 123,
    HeaderField: '<string>',
    Design: '<string>',
    RegisterViews: true,
    InlineImages: true,
    LongDescription: '<string>',
    AccessKey: '<string>',
    DocumentMessage: 123,
    Registered: '2023-11-07T05:31:56Z',
    RegisteredAssociateId: 123,
    Updated: '2023-11-07T05:31:56Z',
    UpdatedAssociateId: 123,
    UpdatedCount: 123,
    TableRight: {Mask: '<string>', Reason: '<string>'},
    FieldProperties: {}
  })
};

fetch('http://localhost:56350/api/v1/ShipmentMessage/{id}', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

{
  "ShipmentMessageId": 123,
  "PlainMessage": "<string>",
  "HtmlMessage": "<string>",
  "SmsMessage": "<string>",
  "Description": "<string>",
  "Subject": "<string>",
  "FolderId": 123,
  "HeaderField": "<string>",
  "Design": "<string>",
  "Designtype": "Unknown",
  "Flags": "Plain",
  "RegisterViews": true,
  "InlineImages": true,
  "LongDescription": "<string>",
  "AccessKey": "<string>",
  "DocumentMessage": 123,
  "Registered": "2023-11-07T05:31:56Z",
  "RegisteredAssociateId": 123,
  "Updated": "2023-11-07T05:31:56Z",
  "UpdatedAssociateId": 123,
  "UpdatedCount": 123,
  "TableRight": {
    "Mask": "<string>",
    "Reason": "<string>"
  },
  "FieldProperties": {},
  "_Links": {}
}

Headers

Accept-Language

string

Convert string references and multi-language values into a specified language (iso2) code.

SO-Language

string

Convert string references and multi-language values into a specified language (iso2) code. Overrides Accept-Language value.

SO-Culture

string

Number, date formatting in a specified culture (iso2 language) code. Partially overrides SO-Language/Accept-Language value. Ignored if no Language set.

SO-TimeZone

string

Specify the timezone code that you would like date/time responses converted to.

SO-AppToken

string

The application token that identifies the partner app. Used when calling Online WebAPI from a server.

Path Parameters

integer<int32>

required

The ShipmentMessageEntity id to update.

Query Parameters

$select

string

Optional comma separated list of properties to include in the result. Other fields are then nulled out to reduce payload size: "Name,department,category" Default = show all fields.

Body

The ShipmentMessageEntity to be saved.

A shipment message, that contains the actual message being sent out in a mailing Carrier object for ShipmentMessageEntity. Services for the ShipmentMessageEntity Carrier is available from the Marketing Agent.

ShipmentMessageId

integer<int32>

Primary key

PlainMessage

string

Plain message text of this message

HtmlMessage

string

HTML formatted text of this message

SmsMessage

string

SMS version of this message

Description

string

Describes this message

Subject

string

The mail subject field of the message

FolderId

integer<int32>

The folder which this message belongs to. -1 indicates that the message is on the root

HeaderField

string

Extra header fields added to mail. Must be formatted correctly

Design

string

Will contain the design part of a message. The format will vary based on the type of designer used to create the message

Designtype

enum<string>

Enum containing the type of the design

Available options:

Unknown,

SOEditor,

Unlayer

Flags

enum<string>

Identifies if HTML or plain message is included in message.

Available options:

Plain,

Html,

SourceView,

Sms,

Document

RegisterViews

boolean

InlineImages

boolean

Should images be included inline?

LongDescription

string

A field for a long description of this template

AccessKey

string

Key used for access verification

DocumentMessage

integer<int32>

The SM document used as template for this mailing

Registered

string<date-time>

Registered when in UTC.

RegisteredAssociateId

integer<int32>

Registered by whom

Updated

string<date-time>

Last updated when in UTC.

UpdatedAssociateId

integer<int32>

Last updated by whom

UpdatedCount

integer<int32>

Number of updates made to this record

TableRight

object

Wraps a table right together with an explanatory reason. Code can indicate why access is restricted.

Show child attributes

FieldProperties

object

Field property dictionary mapping field names to field access rights.

Show child attributes

Response

ShipmentMessageEntity updated.

A shipment message, that contains the actual message being sent out in a mailing ShipmentMessageEntity entity with API _Links added.

ShipmentMessageId

integer<int32>

Primary key

PlainMessage

string

Plain message text of this message

HtmlMessage

string

HTML formatted text of this message

SmsMessage

string

SMS version of this message

Description

string

Describes this message

Subject

string

The mail subject field of the message

FolderId

integer<int32>

The folder which this message belongs to. -1 indicates that the message is on the root

HeaderField

string

Extra header fields added to mail. Must be formatted correctly

Design

string

Will contain the design part of a message. The format will vary based on the type of designer used to create the message

Designtype

enum<string>

Enum containing the type of the design

Available options:

Unknown,

SOEditor,

Unlayer

Flags

enum<string>

Identifies if HTML or plain message is included in message.

Available options:

Plain,

Html,

SourceView,

Sms,

Document

RegisterViews

boolean

InlineImages

boolean

Should images be included inline?

LongDescription

string

A field for a long description of this template

AccessKey

string

Key used for access verification

DocumentMessage

integer<int32>

The SM document used as template for this mailing

Registered

string<date-time>

Registered when in UTC.

RegisteredAssociateId

integer<int32>

Registered by whom

Updated

string<date-time>

Last updated when in UTC.

UpdatedAssociateId

integer<int32>

Last updated by whom

UpdatedCount

integer<int32>

Number of updates made to this record

TableRight

object

Wraps a table right together with an explanatory reason. Code can indicate why access is restricted.

Show child attributes

FieldProperties

object

Field property dictionary mapping field names to field access rights.

Show child attributes

_Links

object

Show child attributes