Skip to main content
Merge Tickets

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

secondaryTicketIds
integer<int32>[]
required

Ids of secondary tickets

mergedTicketEntity.ticketId
integer<int32>

The primary key (auto-incremented)

mergedTicketEntity.title
string

The title of the ticket.

mergedTicketEntity.createdAt
string<date-time>

When the ticket was created.

mergedTicketEntity.lastChanged
string<date-time>

The last time the ticket was modified.

mergedTicketEntity.readByOwner
string<date-time>

The datetime for when the ticket last was read by the owner.

mergedTicketEntity.readByCustomer
string<date-time>

The datetime for when the ticket was read by the customer.

mergedTicketEntity.firstReadByOwner
string<date-time>

The datetime for when the ticket first was read by the current owner.

mergedTicketEntity.firstReadByUser
string<date-time>

The datetime for when the ticket first was read by a user.

mergedTicketEntity.activate
string<date-time>

When the ticket should be activated, if it is postponed.

mergedTicketEntity.closedAt
string<date-time>

When the ticket was closed.

mergedTicketEntity.repliedAt
string<date-time>

The datetime for when the ticket was replied to. I.e. the first external message added to the ticket.

mergedTicketEntity.alertTimeout
string<date-time>

The datetime for when the ticket should jump to the next alert_level.

mergedTicketEntity.deadline
string<date-time>

Deadline for ticket.

mergedTicketEntity.createdBy.associateId
integer<int32>

Primary key

mergedTicketEntity.createdBy.name
string

Initials, also login name, possibly database user name

mergedTicketEntity.createdBy.personId
integer<int32>

Owning person record Use MDO List name "person" to get list items.

mergedTicketEntity.createdBy.rank
integer<int32>

Rank order

mergedTicketEntity.createdBy.tooltip
string

Tooltip or other description

mergedTicketEntity.createdBy.type
enum<string>

User type - 1 = internal user, 2 = resource, 3 = external user, 4 = anonymous, 5 = system

Available options:
Unknown,
InternalAssociate,
ResourceAssociate,
ExternalAssociate,
AnonymousAssociate,
SystemAssociate
mergedTicketEntity.createdBy.groupIdx
integer<int32>

Primary group membership, see UserGroupLink for secondary memberships

mergedTicketEntity.createdBy.fullName
string

The associate's culture formatted fullname (firstname, middleName and lastname)

mergedTicketEntity.createdBy.formalName
string

The associate's culture formatted formalname (firstname, middleName and lastname, title, mrmrs)

mergedTicketEntity.createdBy.deleted
boolean

If true, the user is retired and should have no rights, not appear in lists, etc.

mergedTicketEntity.createdBy.ejUserId
integer<int32>

ID of the ej user record corresponding to this associate; 0 for associates that are not ej users

mergedTicketEntity.createdBy.userName
string

User name

mergedTicketEntity.createdBy.extraFields
object

Deprecated: Use {SuperOffice.CRM.Services.Associate.CustomFields} instead. Extra fields added to the carrier. This could be data from Plug-ins, the foreign key system, external applications, etc.

mergedTicketEntity.createdBy.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.Associate.ExtraFields} and UserDefinedFields properties are deprecated in favor of this combined collection.

mergedTicketEntity.createdBy.tableRight.mask
string
mergedTicketEntity.createdBy.tableRight.reason
string
mergedTicketEntity.createdBy.fieldProperties
object

Field property dictionary mapping field names to field access rights.

mergedTicketEntity.author
string

A string representing the author of the ticket (same as author of first message).

mergedTicketEntity.ownedBy.associateId
integer<int32>

Primary key

mergedTicketEntity.ownedBy.name
string

Initials, also login name, possibly database user name

mergedTicketEntity.ownedBy.personId
integer<int32>

Owning person record Use MDO List name "person" to get list items.

mergedTicketEntity.ownedBy.rank
integer<int32>

Rank order

mergedTicketEntity.ownedBy.tooltip
string

Tooltip or other description

mergedTicketEntity.ownedBy.type
enum<string>

User type - 1 = internal user, 2 = resource, 3 = external user, 4 = anonymous, 5 = system

Available options:
Unknown,
InternalAssociate,
ResourceAssociate,
ExternalAssociate,
AnonymousAssociate,
SystemAssociate
mergedTicketEntity.ownedBy.groupIdx
integer<int32>

Primary group membership, see UserGroupLink for secondary memberships

mergedTicketEntity.ownedBy.fullName
string

The associate's culture formatted fullname (firstname, middleName and lastname)

mergedTicketEntity.ownedBy.formalName
string

The associate's culture formatted formalname (firstname, middleName and lastname, title, mrmrs)

mergedTicketEntity.ownedBy.deleted
boolean

If true, the user is retired and should have no rights, not appear in lists, etc.

mergedTicketEntity.ownedBy.ejUserId
integer<int32>

ID of the ej user record corresponding to this associate; 0 for associates that are not ej users

mergedTicketEntity.ownedBy.userName
string

User name

mergedTicketEntity.ownedBy.extraFields
object

Deprecated: Use {SuperOffice.CRM.Services.Associate.CustomFields} instead. Extra fields added to the carrier. This could be data from Plug-ins, the foreign key system, external applications, etc.

mergedTicketEntity.ownedBy.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.Associate.ExtraFields} and UserDefinedFields properties are deprecated in favor of this combined collection.

mergedTicketEntity.ownedBy.tableRight.mask
string
mergedTicketEntity.ownedBy.tableRight.reason
string
mergedTicketEntity.ownedBy.fieldProperties
object

Field property dictionary mapping field names to field access rights.

mergedTicketEntity.category.ticketCategoryId
integer<int32>

The id of the ticket category. (primary key)

mergedTicketEntity.category.parentId
integer<int32>

The parent category for this category. -1 if this is a toplevel category.

mergedTicketEntity.category.name
string

The (short) name of this category. E.g. 'support'.

mergedTicketEntity.category.fullname
string

The fullname (compiled from parents' names) for this category. E.g. 'norway/product A/support'.

mergedTicketEntity.category.categoryMaster
integer<int32>

The user associated with this category.

mergedTicketEntity.category.flags
enum<string>

A bitmask representing flags for this category.

Available options:
Unknown,
Internal,
OnlyLoggedInUsers,
DefaultToCategoryMaster,
ListInMain,
RedelegateNewMsg,
DelegateToOurContact,
PropagateReplyTemplate,
MembersOnly,
NotifyMembers,
AcceptWhenReplying
mergedTicketEntity.category.delegateMethod
enum<string>

An integer indicating the delegation method for this category.

Available options:
Unknown,
Even,
Weighted,
Unfair,
Not
mergedTicketEntity.category.externalName
string

The external name for this category, used for the customer frontend.

mergedTicketEntity.category.closingStatus
enum<string>

Determines the default status used in the GUI when creating a ticket

Available options:
UserDefined,
Active,
Closed,
Postponed
mergedTicketEntity.category.msgClosingStatus
enum<string>

Determines the default status used in the GUI when adding a request to a ticket

Available options:
UserDefined,
Active,
Closed,
Postponed
mergedTicketEntity.category.assignmentLag
integer<int32>

Number of minutes we shall override the assignment if a customer sends consecutive messages to this category

mergedTicketEntity.category.replyTemplate
integer<int32>

Reply template to merge with messages posted in this category

mergedTicketEntity.category.notificationEmail
string

Comma separated list of addresses to notify when requests are redelegated to (unassigned) in this category.

mergedTicketEntity.category.defaultTicketStatus.ticketStatusId
integer<int32>

The primary key (auto-incremented)

mergedTicketEntity.category.defaultTicketStatus.name
string

Name of user defined ticket status

mergedTicketEntity.category.defaultTicketStatus.status
enum<string>

The 'classic' ticket status. I.e. active/closed/postponed/deleted

Available options:
Unknown,
Active,
Closed,
Postponed,
Deleted,
Merged,
Spam,
PostponedSpecific,
Postponed1Hour,
Postponed2Hours,
Postponed3Hours,
Postponed4Hours,
PostponedDay,
PostponedWeek,
PostponedMonth
mergedTicketEntity.category.defaultTicketStatus.timeCounter
enum<string>

Which field in ticket we count time spent on (queue, internal, external)

Available options:
None,
Internally,
Externally,
Queue
mergedTicketEntity.category.defaultTicketStatus.noEmailReopen
boolean

Whether inbound emails can reopen requests with this status or not

mergedTicketEntity.category.defaultTicketStatus.isDefault
boolean

Indicates if status is default one as there might be more than one status with same internal status

mergedTicketEntity.category.defaultTicketStatus.usedInQueue
boolean

If set, status is used in GetNext calculations

mergedTicketEntity.category.defaultTicketStatus.tableRight.mask
string
mergedTicketEntity.category.defaultTicketStatus.tableRight.reason
string
mergedTicketEntity.category.defaultTicketStatus.fieldProperties
object

Field property dictionary mapping field names to field access rights.

mergedTicketEntity.category.defaultMessageStatus.ticketStatusId
integer<int32>

The primary key (auto-incremented)

mergedTicketEntity.category.defaultMessageStatus.name
string

Name of user defined ticket status

mergedTicketEntity.category.defaultMessageStatus.status
enum<string>

The 'classic' ticket status. I.e. active/closed/postponed/deleted

Available options:
Unknown,
Active,
Closed,
Postponed,
Deleted,
Merged,
Spam,
PostponedSpecific,
Postponed1Hour,
Postponed2Hours,
Postponed3Hours,
Postponed4Hours,
PostponedDay,
PostponedWeek,
PostponedMonth
mergedTicketEntity.category.defaultMessageStatus.timeCounter
enum<string>

Which field in ticket we count time spent on (queue, internal, external)

Available options:
None,
Internally,
Externally,
Queue
mergedTicketEntity.category.defaultMessageStatus.noEmailReopen
boolean

Whether inbound emails can reopen requests with this status or not

mergedTicketEntity.category.defaultMessageStatus.isDefault
boolean

Indicates if status is default one as there might be more than one status with same internal status

mergedTicketEntity.category.defaultMessageStatus.usedInQueue
boolean

If set, status is used in GetNext calculations

mergedTicketEntity.category.defaultMessageStatus.tableRight.mask
string
mergedTicketEntity.category.defaultMessageStatus.tableRight.reason
string
mergedTicketEntity.category.defaultMessageStatus.fieldProperties
object

Field property dictionary mapping field names to field access rights.

mergedTicketEntity.category.effectiveReplyTemplateId
integer<int32>

Id of reply template to merge into messages, whose ticket belongs to this category. Also takes into account 'Apply to subcategories' on parent categories. This is a calculated, readonly field.

mergedTicketEntity.category.extraFields
object

Deprecated: Use {SuperOffice.CRM.Services.TicketCategoryEntity.CustomFields} instead. Extra fields added to the carrier. This could be data from Plug-ins, the foreign key system, external applications, etc.

mergedTicketEntity.category.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.TicketCategoryEntity.ExtraFields} and UserDefinedFields properties are deprecated in favor of this combined collection.

mergedTicketEntity.category.tableRight.mask
string
mergedTicketEntity.category.tableRight.reason
string
mergedTicketEntity.category.fieldProperties
object

Field property dictionary mapping field names to field access rights.

mergedTicketEntity.slevel
enum<string>

The securitylevel of the ticket.

Available options:
Unknown,
Internal,
External
mergedTicketEntity.priority.ticketPriorityId
integer<int32>

The primary key (auto-incremented)

mergedTicketEntity.priority.name
string

The name of the priority.

mergedTicketEntity.priority.status
enum<string>

The status (normal/deleted) of the priority.

Available options:
Unknown,
Normal,
Deleted
mergedTicketEntity.priority.flags
enum<string>

A bitmask of flags.

Available options:
Unknown,
External,
Default,
AlertSchedule
mergedTicketEntity.priority.sortOrder
integer<int32>

Indicates the sort order for this priority. 1 is first, 100 is last

mergedTicketEntity.priority.ticketRead
enum<string>

This field indicates what to do with the escalation chain when the request is read

Available options:
None,
Stop,
Continue,
Restart
mergedTicketEntity.priority.changedOwner
enum<string>

This field indicates what to do with the escalation chain when the request changes owner (manually)

Available options:
None,
Stop,
Continue,
Restart
mergedTicketEntity.priority.ticketNewinfo
enum<string>

This field indicates what to do with the escalation chain when the request gets new info

Available options:
None,
Stop,
Continue,
Restart
mergedTicketEntity.priority.ticketClosed
enum<string>

This field indicates what to do with the escalation chain when the request is closed

Available options:
None,
Stop,
Continue,
Restart
mergedTicketEntity.priority.ticketChangedPriority
enum<string>

This field indicates what to do with the escalation chain when the request is changed into this priority

Available options:
None,
Stop,
Continue,
Restart
mergedTicketEntity.priority.ticketNew
enum<string>

This field indicates what to do with the escalation chain when a new request is registered

Available options:
None,
Stop,
Continue,
Restart
mergedTicketEntity.priority.deadline
integer<int32>

Deadline to add if escalated (minutes)

mergedTicketEntity.priority.monStart
string<date-time>

The work hour start for Mondays. Note that only the time part of the DateTime is used

mergedTicketEntity.priority.monStop
string<date-time>

The work hour start for Mondays. Note that only the time part of the DateTime is used

mergedTicketEntity.priority.tueStart
string<date-time>

The work hour start for Tuesdays. Note that only the time part of the DateTime is used

mergedTicketEntity.priority.tueStop
string<date-time>

The work hour stop for Tuesdays. Note that only the time part of the DateTime is used

mergedTicketEntity.priority.wedStart
string<date-time>

The work hour start for Wednesdays. Note that only the time part of the DateTime is used

mergedTicketEntity.priority.wedStop
string<date-time>

The work hour stop for Wednesdays. Note that only the time part of the DateTime is used

mergedTicketEntity.priority.thuStart
string<date-time>

The work hour start for Thursdays. Note that only the time part of the DateTime is used

mergedTicketEntity.priority.thuStop
string<date-time>

The work hour stop for Thursdays. Note that only the time part of the DateTime is used

mergedTicketEntity.priority.friStart
string<date-time>

The work hour start for Fridays. Note that only the time part of the DateTime is used

mergedTicketEntity.priority.friStop
string<date-time>

The work hour stop for Fridays. Note that only the time part of the DateTime is used

mergedTicketEntity.priority.satStart
string<date-time>

The work hour start for Saturdays. Note that only the time part of the DateTime is used

mergedTicketEntity.priority.satStop
string<date-time>

The work hour stop for Saturdays. Note that only the time part of the DateTime is used

mergedTicketEntity.priority.sunStart
string<date-time>

The work hour start for Sundays. Note that only the time part of the DateTime is used

mergedTicketEntity.priority.sunStop
string<date-time>

The work hour stop for Sundays. Note that only the time part of the DateTime is used

mergedTicketEntity.priority.nonDates
string<date-time>[]

Dates which the escalation time should not be running. Note that only the day of the year (day and month) is used. So the year and time part is not used even if this is a DateTime. Exception - it IS possible to include a year here, for dates that should not repeat every year

mergedTicketEntity.priority.escalationLevels
any[]

Escalation levels bound to the parent priority

mergedTicketEntity.priority.tableRight.mask
string
mergedTicketEntity.priority.tableRight.reason
string
mergedTicketEntity.priority.fieldProperties
object

Field property dictionary mapping field names to field access rights.

mergedTicketEntity.baseStatus
enum<string>

The status of the ticket. I.e. active/closed/postponed/deleted Use MDO List name "ticketstatus" to get list items.

Available options:
Unknown,
Active,
Closed,
Postponed,
Deleted,
Merged,
Spam,
PostponedSpecific,
Postponed1Hour,
Postponed2Hours,
Postponed3Hours,
Postponed4Hours,
PostponedDay,
PostponedWeek,
PostponedMonth
mergedTicketEntity.status.ticketStatusId
integer<int32>

The primary key (auto-incremented)

mergedTicketEntity.status.name
string

Name of user defined ticket status

mergedTicketEntity.status.status
enum<string>

The 'classic' ticket status. I.e. active/closed/postponed/deleted

Available options:
Unknown,
Active,
Closed,
Postponed,
Deleted,
Merged,
Spam,
PostponedSpecific,
Postponed1Hour,
Postponed2Hours,
Postponed3Hours,
Postponed4Hours,
PostponedDay,
PostponedWeek,
PostponedMonth
mergedTicketEntity.status.timeCounter
enum<string>

Which field in ticket we count time spent on (queue, internal, external)

Available options:
None,
Internally,
Externally,
Queue
mergedTicketEntity.status.noEmailReopen
boolean

Whether inbound emails can reopen requests with this status or not

mergedTicketEntity.status.isDefault
boolean

Indicates if status is default one as there might be more than one status with same internal status

mergedTicketEntity.status.usedInQueue
boolean

If set, status is used in GetNext calculations

mergedTicketEntity.status.tableRight.mask
string
mergedTicketEntity.status.tableRight.reason
string
mergedTicketEntity.status.fieldProperties
object

Field property dictionary mapping field names to field access rights.

mergedTicketEntity.origin
enum<string>

What is the origin of this ticket

Available options:
Unknown,
Email,
SMS,
Fax,
Phone,
Facebook,
Twitter,
Internal,
CustomerCentre,
EMarketing,
AutoGenerated,
Chat,
Form,
API,
Flow
mergedTicketEntity.person.position
string

The position. This is a predefined SuperOffice value, different from Title

mergedTicketEntity.person.personId
integer<int32>

Primary key

mergedTicketEntity.person.mrmrs
string

e.g. Mrs sex_title

mergedTicketEntity.person.firstname
string

First name

mergedTicketEntity.person.lastname
string

Last name

mergedTicketEntity.person.middleName
string

Middle name or 'van' etc.

mergedTicketEntity.person.title
string

Title

mergedTicketEntity.person.description
string

Info text/description on person.

mergedTicketEntity.person.email
string

First email on contact person.

mergedTicketEntity.person.fullName
string

Get the persons full name (internal name used in clients for employees).

mergedTicketEntity.person.directPhone
string

Returns the direct phone that belong to the contact person.

mergedTicketEntity.person.formalName
string

Get formal name for a person, as used in labels. (Full name + person title + academic title)

mergedTicketEntity.person.countryId
integer<int32>

Country

mergedTicketEntity.person.contactId
integer<int32>

Owning contact ID

mergedTicketEntity.person.contactName
string

The persons company name

mergedTicketEntity.person.retired
integer<int32>

1 = the user is retired and should have no rights, not appear in lists, etc.

mergedTicketEntity.person.rank
integer<int32>

Display sort sequence for default sort order

mergedTicketEntity.person.activeInterests
integer<int32>

Number of records in pintr table; select count(*) from pintr pi where pi.person_id = this.person_id == activeInterests is always true

mergedTicketEntity.person.contactDepartment
string

The persons contact department

mergedTicketEntity.person.contactCountryId
integer<int32>

The persons contact country id

mergedTicketEntity.person.contactOrgNr
string

The persons contact organization number

mergedTicketEntity.person.faxPhone
string

Returns the fax phone that belong to the contact person.

mergedTicketEntity.person.mobilePhone
string

Returns the mobile phone that belong to the contact person.

mergedTicketEntity.person.contactPhone
string

Returns the direct phone that belong to the persons contact.

mergedTicketEntity.person.associateName
string

Name of the person's owner

mergedTicketEntity.person.associateId
integer<int32>

Id of the item's owner (Associate id)

mergedTicketEntity.person.usePersonAddress
boolean

If 1, use person's address for mailing instead of company address

mergedTicketEntity.person.contactFax
string

Actual phone number as eneterd by the user

mergedTicketEntity.person.kanafname
string

Kana first name, used in Japanese versions only

mergedTicketEntity.person.kanalname
string

Kana last name, used in Japanese versions only

mergedTicketEntity.person.post1
string

Postal address, used in Japanese versions only

mergedTicketEntity.person.post2
string

Postal address, used in Japanese versions only

mergedTicketEntity.person.post3
string

Postal address, used in Japanese versions only

mergedTicketEntity.person.emailName
string

E-mail description

mergedTicketEntity.person.contactFullName
string

Company full name + department

How many active ERP links are there for this person?

mergedTicketEntity.person.ticketPriorityId
integer<int32>

Ticket priority ID

mergedTicketEntity.person.supportLanguageId
integer<int32>

Support priority ID

mergedTicketEntity.person.supportAssociateId
integer<int32>

Our support contact for this person

mergedTicketEntity.person.categoryName
string

The category list item name

mergedTicketEntity.person.personNumber
string

Alphanumeric user field

mergedTicketEntity.person.tableRight.mask
string
mergedTicketEntity.person.tableRight.reason
string
mergedTicketEntity.person.fieldProperties
object

Field property dictionary mapping field names to field access rights.

mergedTicketEntity.secondaryPersons
any[]

The secondary persons this ticket is connected to Use MDO List name "person_new" to get list items.

mergedTicketEntity.alertLevel
integer<int32>

The alert level for the ticket. Matches the level value of the ticket_alert table.

mergedTicketEntity.connectId
integer<int32>

If a ticket is connected to another ticket, this field is set to the id of the 'master' ticket.

mergedTicketEntity.readStatus
enum<string>

Whether the owner has read the ticket or not (red, yellow, green).

Available options:
Unknown,
Green,
Yellow,
Red
mergedTicketEntity.timeToReply
integer<int32>

The time (minutes) between when the ticket was created and when it was replied to. Calculated based on priority's timeframe.

mergedTicketEntity.realTimeToReply
integer<int32>

Same as time_to_reply, but not calculated based on priority.

mergedTicketEntity.timeToClose
integer<int32>

The time (minutes) between when the ticket was created and when it was closed. Calculated based on priority's timeframe.

mergedTicketEntity.realTimeToClose
integer<int32>

Same as time_to_close, but not calculated based on priority.

mergedTicketEntity.timeSpentInternally
integer<int32>

The total time (seconds) within the priority's office hours the ticket has been in an open status (configurable), not including current state

mergedTicketEntity.timeSpentExternally
integer<int32>

The total time (seconds) within the priority's office hours the ticket has been in a external waiting status (configurable), not including current state

mergedTicketEntity.timeSpentQueue
integer<int32>

The total time (seconds) within the priority's office hours the ticket has been in a queue status, not including current state

mergedTicketEntity.realTimeSpentInternally
integer<int32>

The total time (seconds) within 24x7 the ticket has been in an open status (configurable), not including current state

mergedTicketEntity.realTimeSpentExternally
integer<int32>

The total time (seconds) within 24x7 the ticket has been in a external waiting status (configurable), not including current state

mergedTicketEntity.realTimeSpentQueue
integer<int32>

The total time (seconds) within 24x7 hours the ticket has been in a queue status, not including current state

mergedTicketEntity.timeSpent
integer<int32>

The total time (minutes). Aggregated time spent from ticket's messages. Read-only for external use.

mergedTicketEntity.hasAttachment
boolean

Boolean indicating if this ticket has one or more attachments.

mergedTicketEntity.numReplies
integer<int32>

The number of replies (messages) to the customer for this request.

mergedTicketEntity.numMessages
integer<int32>

The total number of messages for this request.

mergedTicketEntity.fromAddress
string

The from-address used when this ticket got created, e.g. by email

mergedTicketEntity.messages
any[]

TicketMessageId,CreatedAt,SLevel and Important for all the messages connected to this ticket. For message body see the TicketMessageEntity or the TicketMessage archive.

mergedTicketEntity.tags
any[]

An array containing the tags assigned to this request

mergedTicketEntity.language
string

The language of the first external message

mergedTicketEntity.sentiment
integer<int32>

The sentiment index of the last external message

mergedTicketEntity.sentimentConfidence
integer<int32>

The sentiment confidence of the last external message

mergedTicketEntity.suggestedCategoryId
integer<int32>

Suggestion for categorization, based on the text of the message (AI)

mergedTicketEntity.suggestedCategoryName
string

Suggested category from AI

mergedTicketEntity.origHumanCategoryId
integer<int32>

Will contain the category id selected by the user, when having the choice of using the suggested category or manually selecting a category

mergedTicketEntity.iconHint
string

Icon representing ticket's state

mergedTicketEntity.sale.contactName
string

Contact name

mergedTicketEntity.sale.saleDate
string<date-time>

(expected / lost / won) sales date

mergedTicketEntity.sale.saleId
integer<int32>

Primary key

mergedTicketEntity.sale.probability
integer<int32>

Actual probability, may differ from the one in the list

mergedTicketEntity.sale.title
string

Sale heading (short description?)

mergedTicketEntity.sale.amount
number<double>

Total sale amount

mergedTicketEntity.sale.currency
string

Currency the sale was made in.

mergedTicketEntity.sale.projectName
string

Project name

mergedTicketEntity.sale.associateFullName
string

The sale's owner

mergedTicketEntity.sale.description
string

The sales description

mergedTicketEntity.sale.status
enum<string>

The sale's status, indicating wether the sale is open, sold or lost.

Available options:
Unknown,
Open,
Sold,
Lost,
Stalled,
SaintAll
mergedTicketEntity.sale.weightedAmount
number<double>

The weighted amount ( amount * probability / 100)

mergedTicketEntity.sale.projectId
integer<int32>

Optional project reference

mergedTicketEntity.sale.earningPercent
number<double>

Earning as percent of total

mergedTicketEntity.sale.earning
number<double>

Earning on sale

mergedTicketEntity.sale.contactId
integer<int32>

Optional contact reference

mergedTicketEntity.sale.associateId
integer<int32>

The sale's owner id

mergedTicketEntity.sale.personId
integer<int32>

The sale's contact persons id

mergedTicketEntity.sale.saleTypeId
integer<int32>

The sale's type id

mergedTicketEntity.sale.saleTypeName
string

The sale's type name

mergedTicketEntity.sale.personFullName
string

The name of the person this sale belongs to.

mergedTicketEntity.sale.completed
enum<string>

The Sale completed state. The completed state is either Started or Completed. NotStarted is treated as Started. The value maps to the Done database field.

Available options:
Unknown,
NotStarted,
Started,
Completed

The number of active erp links

mergedTicketEntity.sale.nextDueDate
string<date-time>

Next due date, this is a denormalization of 'closest future activity date, or most recent if no future activities'. Maintained by the system, but very convenient for searching.

mergedTicketEntity.sale.number
string

Alphanumeric user field

mergedTicketEntity.sale.tableRight.mask
string
mergedTicketEntity.sale.tableRight.reason
string
mergedTicketEntity.sale.fieldProperties
object

Field property dictionary mapping field names to field access rights.

mergedTicketEntity.project.projectId
integer<int32>

Primary key

mergedTicketEntity.project.name
string

Project name

mergedTicketEntity.project.description
string

The projects description

mergedTicketEntity.project.uRL
string

URL address

mergedTicketEntity.project.type
string

The project type.

mergedTicketEntity.project.associateId
integer<int32>

The project owner id (associate id)

mergedTicketEntity.project.associateFullName
string

The project owner

mergedTicketEntity.project.typeId
integer<int32>
mergedTicketEntity.project.updated
string<date-time>

Last updated date in UTC.

mergedTicketEntity.project.statusId
integer<int32>

The projects status id

mergedTicketEntity.project.status
string

The projects status

mergedTicketEntity.project.textId
integer<int32>

The id of the description

mergedTicketEntity.project.publishTo
string<date-time>

Publication valid to (inclusive)

mergedTicketEntity.project.publishFrom
string<date-time>

Publication valid from (inclusive)

mergedTicketEntity.project.isPublished
boolean
mergedTicketEntity.project.uRLName
string

Visible field

mergedTicketEntity.project.projectNumber
string

Automatically generated number

The number of active erp links

mergedTicketEntity.project.eventId
integer<int32>

Reserved field for Lyyti event when project is linked to an event.

mergedTicketEntity.project.startDate
string<date-time>

Reserved field for Lyyti event when project is linked to an event, is the event start date.

mergedTicketEntity.project.tableRight.mask
string
mergedTicketEntity.project.tableRight.reason
string
mergedTicketEntity.project.fieldProperties
object

Field property dictionary mapping field names to field access rights.

mergedTicketEntity.formSubmission.formSubmissionId
integer<int32>

Primary key

mergedTicketEntity.formSubmission.emailAddress
string

The email address of the person who submitted

mergedTicketEntity.formSubmission.status
enum<string>

What is the status of this submission

Available options:
Unknown,
InProgress,
EmailVerification,
Submitted,
Processed,
Failed
mergedTicketEntity.ticketType.ticketTypeId
integer<int32>

Primary key

mergedTicketEntity.ticketType.name
string

The list item

mergedTicketEntity.ticketType.icon
string

Name of the icon

mergedTicketEntity.ticketType.defaultTicketStatus
integer<int32>

Default ticket status for new tickets

mergedTicketEntity.ticketType.defaultTicketPriority
integer<int32>

Default ticket priority for new tickets

mergedTicketEntity.ticketType.isDefault
boolean

Is this Ticket Type marked as default

mergedTicketEntity.ticketType.showInNew
boolean

Enables this request type to be accessible in +New in top bar

mergedTicketEntity.ticketType.excludeSignature
boolean

Do not insert user signature automatically

mergedTicketEntity.ticketType.excludeEmailRecipients
boolean

Create request without initially having to send outbound e-mail

mergedTicketEntity.ticketType.externalAsDefault
boolean

Ability to set external access level for this request type

mergedTicketEntity.ticketType.visibleForGroups
integer<int32>[]

Array of references to the visible for groups

mergedTicketEntity.ticketType.replyForwardNoSignature
boolean

Do not insert user signature when replying or forwarding the message

mergedTicketEntity.ticketType.replyExternalAsDefault
boolean

Set external access level when replying the message

mergedTicketEntity.ticketType.tableRight.mask
string
mergedTicketEntity.ticketType.tableRight.reason
string
mergedTicketEntity.ticketType.fieldProperties
object

Field property dictionary mapping field names to field access rights.

mergedTicketEntity.activeStatusMonitorId
integer<int32>

Active status monitor identity for related contact. This is a read-only property and is ignored on Save

mergedTicketEntity.extraFields
object

Deprecated: Use {SuperOffice.CRM.Services.TicketEntity.CustomFields} instead. Extra fields added to the carrier. This could be data from Plug-ins, the foreign key system, external applications, etc.

mergedTicketEntity.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.TicketEntity.ExtraFields} and UserDefinedFields properties are deprecated in favor of this combined collection.

mergedTicketEntity.tableRight.mask
string
mergedTicketEntity.tableRight.reason
string
mergedTicketEntity.fieldProperties
object

Field property dictionary mapping field names to field access rights.

Response

OK

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

TicketId
integer<int32>

The primary key (auto-incremented)

Title
string

The title of the ticket.

CreatedAt
string<date-time>

When the ticket was created.

LastChanged
string<date-time>

The last time the ticket was modified.

ReadByOwner
string<date-time>

The datetime for when the ticket last was read by the owner.

ReadByCustomer
string<date-time>

The datetime for when the ticket was read by the customer.

FirstReadByOwner
string<date-time>

The datetime for when the ticket first was read by the current owner.

FirstReadByUser
string<date-time>

The datetime for when the ticket first was read by a user.

Activate
string<date-time>

When the ticket should be activated, if it is postponed.

ClosedAt
string<date-time>

When the ticket was closed.

RepliedAt
string<date-time>

The datetime for when the ticket was replied to. I.e. the first external message added to the ticket.

AlertTimeout
string<date-time>

The datetime for when the ticket should jump to the next alert_level.

Deadline
string<date-time>

Deadline for ticket.

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 ticket (same as author of first message).

OwnedBy
object

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

Category
object

This entity describes the meta data for a ticket category, and provides special operations on it. Carrier object for TicketCategoryEntity. Services for the TicketCategoryEntity Carrier is available from the List Agent.

Slevel
enum<string>

The securitylevel of the ticket.

Available options:
Unknown,
Internal,
External
Priority
object

Entity for a ticket priority. This entity describes the meta data for a ticket priority, and provides special operations on it. Carrier object for TicketPriorityEntity. Services for the TicketPriorityEntity Carrier is available from the List Agent.

BaseStatus
enum<string>

The status of the ticket. I.e. active/closed/postponed/deleted Use MDO List name "ticketstatus" to get list items.

Available options:
Unknown,
Active,
Closed,
Postponed,
Deleted,
Merged,
Spam,
PostponedSpecific,
Postponed1Hour,
Postponed2Hours,
Postponed3Hours,
Postponed4Hours,
PostponedDay,
PostponedWeek,
PostponedMonth
Status
object

Entity for a ticket status. This entity describes the meta data for a ticket status, and provides special operations on it. Carrier object for TicketStatusEntity. Services for the TicketStatusEntity Carrier is available from the List Agent.

Origin
enum<string>

What is the origin of this ticket

Available options:
Unknown,
Email,
SMS,
Fax,
Phone,
Facebook,
Twitter,
Internal,
CustomerCentre,
EMarketing,
AutoGenerated,
Chat,
Form,
API,
Flow
Person
object

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

SecondaryPersons
object[]

The secondary persons this ticket is connected to Use MDO List name "person_new" to get list items.

AlertLevel
integer<int32>

The alert level for the ticket. Matches the level value of the ticket_alert table.

ConnectId
integer<int32>

If a ticket is connected to another ticket, this field is set to the id of the 'master' ticket.

ReadStatus
enum<string>

Whether the owner has read the ticket or not (red, yellow, green).

Available options:
Unknown,
Green,
Yellow,
Red
TimeToReply
integer<int32>

The time (minutes) between when the ticket was created and when it was replied to. Calculated based on priority's timeframe.

RealTimeToReply
integer<int32>

Same as time_to_reply, but not calculated based on priority.

TimeToClose
integer<int32>

The time (minutes) between when the ticket was created and when it was closed. Calculated based on priority's timeframe.

RealTimeToClose
integer<int32>

Same as time_to_close, but not calculated based on priority.

TimeSpentInternally
integer<int32>

The total time (seconds) within the priority's office hours the ticket has been in an open status (configurable), not including current state

TimeSpentExternally
integer<int32>

The total time (seconds) within the priority's office hours the ticket has been in a external waiting status (configurable), not including current state

TimeSpentQueue
integer<int32>

The total time (seconds) within the priority's office hours the ticket has been in a queue status, not including current state

RealTimeSpentInternally
integer<int32>

The total time (seconds) within 24x7 the ticket has been in an open status (configurable), not including current state

RealTimeSpentExternally
integer<int32>

The total time (seconds) within 24x7 the ticket has been in a external waiting status (configurable), not including current state

RealTimeSpentQueue
integer<int32>

The total time (seconds) within 24x7 hours the ticket has been in a queue status, not including current state

TimeSpent
integer<int32>

The total time (minutes). Aggregated time spent from ticket's messages. Read-only for external use.

HasAttachment
boolean

Boolean indicating if this ticket has one or more attachments.

NumReplies
integer<int32>

The number of replies (messages) to the customer for this request.

NumMessages
integer<int32>

The total number of messages for this request.

FromAddress
string

The from-address used when this ticket got created, e.g. by email

Messages
object[]

TicketMessageId,CreatedAt,SLevel and Important for all the messages connected to this ticket. For message body see the TicketMessageEntity or the TicketMessage archive.

Tags
object[]

An array containing the tags assigned to this request

Language
string

The language of the first external message

Sentiment
integer<int32>

The sentiment index of the last external message

SentimentConfidence
integer<int32>

The sentiment confidence of the last external message

SuggestedCategoryId
integer<int32>

Suggestion for categorization, based on the text of the message (AI)

SuggestedCategoryName
string

Suggested category from AI

OrigHumanCategoryId
integer<int32>

Will contain the category id selected by the user, when having the choice of using the suggested category or manually selecting a category

IconHint
string

Icon representing ticket's state

Sale
object

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

Project
object

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

FormSubmission
object

Class representing form submission related to ticket. Carrier object for TicketFormSubmission.

TicketType
object

Ticket Type - light read-only version of TicketTypeEntity. Carrier object for TicketType. Services for the TicketType Carrier is available from the List Agent.

ActiveStatusMonitorId
integer<int32>

Active status monitor identity for related contact. This is a read-only property and is ignored on Save

ExtraFields
object

Deprecated: Use {SuperOffice.CRM.Services.TicketEntity.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.TicketEntity.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.