PATCH TicketMessage/{id}

• 7 minutes to read

PATCH /api/v1/TicketMessage/{id}

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

See RFC6902 and RFC 7396. NsApiSlow threshold: 2000 ms. 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.ITicketAgent} service SaveTicketMessageEntity.

Path Part	Type	Description
id	int32	The TicketMessageEntity 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/TicketMessage/{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:

TicketMessageEntity updated.

Response	Description
200	TicketMessageEntity updated.
404	TicketMessageEntity 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 TicketMessageEntity has changed since the requested If-Unmodified-Since timestamp.

Response body: TicketMessageEntityWithLinks

Property Name	Type	Description
EjMessageId	int32	The primary key (auto-incremented)
Ticket	Ticket	The connected ticket
CreatedAt	date-time	When the message was posted.
CreatedBy	Associate	The associate who created this ticket message
Author	string	A string representing the author of the message. Could be a user's name, or a persons email address.
Slevel	string	The securitylevel of the message.
Type	string	The type of the message (plaintext/html).
MessageId	string	The Message-Id header value from the email. Used for threading, i.e. connecting messages to existing tickets.
TimeSpent	int32	The time spent (minutes) for this message.
Body	string	The textbody for the message.
HtmlBody	string	The html body for the message (if any).
EmailHeader	string	The email header is saved in this field as raw text
DebugInfo	string	The debug info for the message.
MailSorter	string	The name of the mail sorter used when the email was imported. Note: We must use name instead of id since the id's change every time one changes the mail sorter. :-0
MessageCategory	string	Defines what kind of message this is.
Person	Person	If this is an incoming message, this will contain the person Use MDO List name "person_new" to get list items.
SearchTitle	string	A copy of the title of the ticket, for search optimisation and simpler reporting.
MessageHeaders	array	Contains the message headers, like To, Cc, Bcc information, or custom headers
Important	bool	If this message is important or not.
Language	string	The language this message is in, based on some kind of analysis
Sentiment	int32	Sentiment index, 100 = completely happy; -100 = suicidally unhappy; 0 = no idea
SentimentConfidence	int32	Confidence of sentiment index, 0 = no idea, 100 = completely sure
Badge	string	Badge to explicitly determine how a message was generated
AttachmentsInfo	array	Message attachments information
ExtraFields	object	Deprecated: Use {SuperOffice.CRM.Services.TicketMessageEntity.CustomFields} instead. Extra fields added to the carrier. This could be data from Plug-ins, the foreign key system, external applications, etc.
CustomFields	object	Udef + Extra fields added to the carrier. Extra fields as defined by changes to database schema + user-defined fields as defined by admin. Custom fields combines user defined fields and extra fields into one bucket. The individual {SuperOffice.CRM.Services.TicketMessageEntity.ExtraFields} and UserDefinedFields properties are deprecated in favor of this combined collection.
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/TicketMessage/{id}
Authorization: Basic dGplMDpUamUw
Accept: application/json; charset=utf-8
Accept-Language: fr,de,ru,zh
Content-Type: application/json; charset=utf-8

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

Sample response

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

{
  "EjMessageId": 875,
  "Ticket": null,
  "CreatedAt": "2007-09-21T14:34:02.6899688+02:00",
  "CreatedBy": null,
  "Author": "vel",
  "Slevel": "External",
  "Type": "Html",
  "MessageId": "tenetur",
  "TimeSpent": 675,
  "Body": "Thank you for contacting support. We will review your request.",
  "HtmlBody": "eius",
  "EmailHeader": "jaquelin@sawayn.biz",
  "DebugInfo": "eum",
  "MailSorter": "ipsum",
  "MessageCategory": "Bounce",
  "Person": null,
  "SearchTitle": "beatae",
  "MessageHeaders": [
    {
      "Id": 355,
      "Name": "Gottlieb Group",
      "Value": "deleniti",
      "StdItem": "CustomerReadFAQ",
      "StdItemCol": "Name",
      "TableRight": null,
      "FieldProperties": {
        "fieldName": {
          "FieldRight": null,
          "FieldType": "System.Int32",
          "FieldLength": 466
        }
      }
    }
  ],
  "Important": false,
  "Language": "cumque",
  "Sentiment": 510,
  "SentimentConfidence": 959,
  "Badge": "Comment",
  "AttachmentsInfo": [
    {
      "AttachmentId": 761,
      "Name": "Keebler-Feeney",
      "ContentType": "rem",
      "AttSize": 937,
      "InlineImage": false,
      "ContentId": "beatae",
      "AuthKey": "reiciendis",
      "IsSafeFileExtension": true,
      "TableRight": null,
      "FieldProperties": {
        "fieldName": {
          "FieldRight": null,
          "FieldType": "System.Int32",
          "FieldLength": 318
        }
      }
    }
  ],
  "ExtraFields": {
    "ExtraFields1": "natus",
    "ExtraFields2": "sequi"
  },
  "CustomFields": {
    "CustomFields1": "molestiae",
    "CustomFields2": "debitis"
  },
  "TableRight": null,
  "FieldProperties": {
    "fieldName": {
      "FieldRight": null,
      "FieldType": "System.String",
      "FieldLength": 999
    }
  },
  "_Links": {
    "Self": "https://www.example.com/api/v1/contact/321",
    "Archive": "https://www.example.com/api/v1/contact"
  }
}