Skip to main content
Save Ticket Message Entity With Notify

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.

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

NewEntity, Notify

SaveTicketMessageEntityWithNotify: Saves a ticket message and performs any user notifications

NewEntity
object

The ticket messages are e-mails, SMS or other messages attached to a ticket (aka request). Carrier object for TicketMessageEntity. Services for the TicketMessageEntity Carrier is available from the Ticket Agent.

Notify
boolean

Response

OK

The ticket messages are e-mails, SMS or other messages attached to a ticket (aka request). Carrier object for TicketMessageEntity. Services for the TicketMessageEntity Carrier is available from the Ticket Agent.

EjMessageId
integer<int32>

The primary key (auto-incremented)

Ticket
object

The ticket carrier is used for representing a service request. Carrier object for Ticket. Services for the Ticket Carrier is available from the Ticket Agent.

CreatedAt
string<date-time>

When the message was posted.

CreatedBy
object

Carrier object for Associate. Services for the Associate Carrier is available from the Associate Agent.

Author
string

A string representing the author of the message. Could be a user's name, or a persons email address.

Slevel
enum<string>

The securitylevel of the message.

Available options:
Unknown,
Internal,
External
Type
enum<string>

The type of the message (plaintext/html).

Available options:
Unknown,
Plain,
Html
MessageId
string

The Message-Id header value from the email. Used for threading, i.e. connecting messages to existing tickets.

TimeSpent
integer<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
enum<string>

Defines what kind of message this is.

Available options:
Message,
Bounce,
OutboxFailed
Person
object

Carrier object for Person. Services for the Person Carrier is available from the Person Agent.

SearchTitle
string

A copy of the title of the ticket, for search optimisation and simpler reporting.

MessageHeaders
object[]

Contains the message headers, like To, Cc, Bcc information, or custom headers

Important
boolean

If this message is important or not.

Language
string

The language this message is in, based on some kind of analysis

Sentiment
integer<int32>

Sentiment index, 100 = completely happy; -100 = suicidally unhappy; 0 = no idea

SentimentConfidence
integer<int32>

Confidence of sentiment index, 0 = no idea, 100 = completely sure

Badge
enum<string>

Badge to explicitly determine how a message was generated

Available options:
Unknown,
Reply,
Forward,
Comment,
Incoming,
Outgoing
AttachmentsInfo
object[]

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
object

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

FieldProperties
object

Field property dictionary mapping field names to field access rights.