PATCH ShipmentMessage/{id}

• 5 minutes to read
 • 5 minutes to read 
PATCH /api/v1/ShipmentMessage/{id}

Update a ShipmentMessageEntity with changes, as described in a JSON Patch or a JSON Merge Patch document.

See RFC6902 and RFC 7396. Update the Department field to "foo" can be done either as a JSON PATCH:


[ { "op": "replace", "path": "/Department", "value": "foo" } ]

or as a JSON MERGE PATCH, which describes the change directly:


{ "Department": "foo" }

JSON PATCH supports operations 'add', 'replace', 'remove' and 'test'. The path is case insensitive, and the leading slash is optional, so the paths "/department", "Department" and "department" are all equivalent.

Calls the {SuperOffice.CRM.Services.IMarketingAgent} service SaveShipmentMessageEntity.

Path Part Type Description
id int32 The ShipmentMessageEntity id to update. Required

Query String Parameters

Parameter Name Type Description
$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. 
PATCH /api/v1/ShipmentMessage/{id}?$select=name,department,category/id

Request Headers

Parameter Name Description
Authorization Supports 'Basic', 'SoTicket' and 'Bearer' schemes, depending on installation type.
X-XSRF-TOKEN If not using Authorization header, you must provide XSRF value from cookie or hidden input field
Content-Type Content-type of the request body:
Accept Content-type(s) you would like the response in: application/json, text/json, application/xml, text/xml, application/json-patch+json, application/merge-patch+json
Accept-Language Convert string references and multi-language values into a specified language (iso2) code.
SO-Language Convert string references and multi-language values into a specified language (iso2) code. Overrides Accept-Language value.
SO-Culture Number, date formatting in a specified culture (iso2 language) code. Partially overrides SO-Language/Accept-Language value. Ignored if no Language set.
SO-TimeZone Specify the timezone code that you would like date/time responses converted to.
SO-AppToken The application token that identifies the partner app. Used when calling Online WebAPI from a server.

Request Body: changes

JSON-Patch array of operations+path+value, or a MERGE-PATCH object (which will be converted to a list of JSON-PATCH operations).

Property Name Type Description
op String "add", "replace", "remove", "test" "move" and "copy" not supported
path String The property names to modify. "/users/0/email", "/users/-",
value Object New/Replaced value - string or object.

Response:

ShipmentMessageEntity updated.

Response Description
200 ShipmentMessageEntity updated.
404 ShipmentMessageEntity with given id does not exist in the db.
409 Update blocked because a 'test' operation has detected a conflict with the entity value.
412 Update aborted because ShipmentMessageEntity has changed since the requested If-Unmodified-Since timestamp.

Response body: ShipmentMessageEntityWithLinks

Property Name Type Description
ShipmentMessageId 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 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 string Enum containing the type of the design
Flags string Identifies if HTML or plain message is included in message.
RegisterViews bool Register message views?
InlineImages bool Should images be included inline?
LongDescription string A field for a long description of this template
AccessKey string Key used for access verification
DocumentMessage int32 The SM document used as template for this mailing
Registered date-time Registered when in UTC.
RegisteredAssociateId int32 Registered by whom
Updated date-time Last updated when in UTC.
UpdatedAssociateId int32 Last updated by whom
UpdatedCount int32 Number of updates made to this record
TableRight TableRight The carrier's table right
FieldProperties object Field property dictionary mapping field names to field access rights.
_Links object

Sample request

PATCH /api/v1/ShipmentMessage/{id}
Authorization: Basic dGplMDpUamUw
Accept: application/json; charset=utf-8
Accept-Language: en
Content-Type: application/json; charset=utf-8

[
  {
    "op": "add",
    "path": "maiores",
    "value": {}
  },
  {
    "op": "add",
    "path": "maiores",
    "value": {}
  }
]

Sample response

HTTP/1.1 200 ShipmentMessageEntity  updated.
Content-Type: application/json; charset=utf-8

{
  "ShipmentMessageId": 727,
  "PlainMessage": "ut",
  "HtmlMessage": "eos",
  "SmsMessage": "doloremque",
  "Description": "Right-sized scalable protocol",
  "Subject": "voluptatem",
  "FolderId": 999,
  "HeaderField": "natus",
  "Design": "maxime",
  "Designtype": "SOEditor",
  "Flags": "Document",
  "RegisterViews": true,
  "InlineImages": false,
  "LongDescription": "Reduced interactive frame",
  "AccessKey": "temporibus",
  "DocumentMessage": 154,
  "Registered": "2008-05-05T14:13:49.2587235+02:00",
  "RegisteredAssociateId": 125,
  "Updated": "2017-11-07T14:13:49.2587235+01:00",
  "UpdatedAssociateId": 159,
  "UpdatedCount": 845,
  "TableRight": null,
  "FieldProperties": {
    "fieldName": {
      "FieldRight": null,
      "FieldType": "System.String",
      "FieldLength": 605
    }
  },
  "_Links": {
    "Self": "https://www.example.com/api/v1/project/321",
    "Archive": "https://www.example.com/api/v1/project"
  }
}