> ## Documentation Index
> Fetch the complete documentation index at: https://docs.superoffice.com/llms.txt
> Use this file to discover all available pages before exploring further.

# Merge Tickets

> Merge one or more tickets into one primary ticket



## OpenAPI

````yaml /openapi/rest/openapi-v3-Ticket.json post /api/v1/Ticket/Merge
openapi: 3.0.0
info:
  version: v1-REST
  title: SuperOffice REST API v1
  description: SuperOffice REST API - Ticket
  contact:
    name: SuperOffice DevNet
    url: https://docs.superoffice.com/en/api/index.html
    email: sdk@superoffice.com
servers:
  - url: http://localhost:56350
  - url: https://localhost:56350
security: []
tags: []
externalDocs:
  description: >-
    The SuperOffice DevNet Community has more documentation, examples, and
    discussion forums.
  url: https://community.superoffice.com/en/developer/
paths:
  /api/v1/Ticket/Merge:
    post:
      tags:
        - Ticket
      summary: Merge Tickets
      description: Merge one or more tickets into one primary ticket
      operationId: v1TicketEntity_MergeTickets
      parameters:
        - name: secondaryTicketIds
          in: query
          description: Ids of secondary tickets
          required: true
          explode: true
          schema:
            type: array
            items:
              format: int32
              type: integer
        - name: mergedTicketEntity.ticketId
          in: query
          description: The primary key (auto-incremented)
          required: false
          schema:
            format: int32
            type: integer
        - name: mergedTicketEntity.title
          in: query
          description: The title of the ticket.
          required: false
          schema:
            type: string
        - name: mergedTicketEntity.createdAt
          in: query
          description: When the ticket was created.
          required: false
          schema:
            format: date-time
            type: string
        - name: mergedTicketEntity.lastChanged
          in: query
          description: The last time the ticket was modified.
          required: false
          schema:
            format: date-time
            type: string
        - name: mergedTicketEntity.readByOwner
          in: query
          description: The datetime for when the ticket last was read by the owner.
          required: false
          schema:
            format: date-time
            type: string
        - name: mergedTicketEntity.readByCustomer
          in: query
          description: The datetime for when the ticket was read by the customer.
          required: false
          schema:
            format: date-time
            type: string
        - name: mergedTicketEntity.firstReadByOwner
          in: query
          description: >-
            The datetime for when the ticket first was read by the current
            owner.
          required: false
          schema:
            format: date-time
            type: string
        - name: mergedTicketEntity.firstReadByUser
          in: query
          description: The datetime for when the ticket first was read by a user.
          required: false
          schema:
            format: date-time
            type: string
        - name: mergedTicketEntity.activate
          in: query
          description: When the ticket should be activated, if it is postponed.
          required: false
          schema:
            format: date-time
            type: string
        - name: mergedTicketEntity.closedAt
          in: query
          description: When the ticket was closed.
          required: false
          schema:
            format: date-time
            type: string
        - name: mergedTicketEntity.repliedAt
          in: query
          description: >-
            The datetime for when the ticket was replied to. I.e. the first
            external message added to the ticket.
          required: false
          schema:
            format: date-time
            type: string
        - name: mergedTicketEntity.alertTimeout
          in: query
          description: >-
            The datetime for when the ticket should jump to the next
            alert_level.
          required: false
          schema:
            format: date-time
            type: string
        - name: mergedTicketEntity.deadline
          in: query
          description: Deadline for ticket.
          required: false
          schema:
            format: date-time
            type: string
        - name: mergedTicketEntity.createdBy.associateId
          in: query
          description: Primary key
          required: false
          schema:
            format: int32
            type: integer
        - name: mergedTicketEntity.createdBy.name
          in: query
          description: Initials, also login name, possibly database user name
          required: false
          schema:
            type: string
        - name: mergedTicketEntity.createdBy.personId
          in: query
          description: "Owning person record \r\n<para>Use MDO List name \"person\" to get list items.</para>"
          required: false
          schema:
            format: int32
            type: integer
        - name: mergedTicketEntity.createdBy.rank
          in: query
          description: Rank order
          required: false
          schema:
            format: int32
            type: integer
        - name: mergedTicketEntity.createdBy.tooltip
          in: query
          description: Tooltip or other description
          required: false
          schema:
            type: string
        - name: mergedTicketEntity.createdBy.type
          in: query
          description: >-
            User type - 1 = internal user, 2 = resource, 3 = external user, 4 =
            anonymous, 5 = system
          required: false
          schema:
            type: string
            enum:
              - Unknown
              - InternalAssociate
              - ResourceAssociate
              - ExternalAssociate
              - AnonymousAssociate
              - SystemAssociate
        - name: mergedTicketEntity.createdBy.groupIdx
          in: query
          description: >-
            Primary group membership, see UserGroupLink for secondary
            memberships
          required: false
          schema:
            format: int32
            type: integer
        - name: mergedTicketEntity.createdBy.fullName
          in: query
          description: >-
            The associate's culture formatted fullname (firstname, middleName
            and lastname)
          required: false
          schema:
            type: string
        - name: mergedTicketEntity.createdBy.formalName
          in: query
          description: >-
            The associate's culture formatted formalname (firstname, middleName
            and lastname, title, mrmrs)
          required: false
          schema:
            type: string
        - name: mergedTicketEntity.createdBy.deleted
          in: query
          description: >-
            If true, the user is retired and should have no rights, not appear
            in lists, etc.
          required: false
          schema:
            type: boolean
        - name: mergedTicketEntity.createdBy.ejUserId
          in: query
          description: >-
            ID of the ej user record corresponding to this associate; 0 for
            associates that are not ej users
          required: false
          schema:
            format: int32
            type: integer
        - name: mergedTicketEntity.createdBy.userName
          in: query
          description: User name
          required: false
          schema:
            type: string
        - name: mergedTicketEntity.createdBy.extraFields
          in: query
          description: "Deprecated: Use {SuperOffice.CRM.Services.Associate.CustomFields} instead.\r\nExtra fields added to the carrier. This could be data from Plug-ins, the foreign key system, external applications, etc."
          required: false
          schema:
            type: object
        - name: mergedTicketEntity.createdBy.customFields
          in: query
          description: "Udef + Extra fields added to the carrier. Extra fields as defined by changes to database schema + user-defined fields as defined by admin.\r\nCustom fields combines user defined fields and extra fields into one bucket. \r\nThe individual {SuperOffice.CRM.Services.Associate.ExtraFields} and <see cref=\"!:UserDefinedFields\">UserDefinedFields</see> properties are deprecated in favor of this\r\ncombined collection."
          required: false
          schema:
            type: object
        - name: mergedTicketEntity.createdBy.tableRight.mask
          in: query
          required: false
          schema:
            type: string
        - name: mergedTicketEntity.createdBy.tableRight.reason
          in: query
          required: false
          schema:
            type: string
        - name: mergedTicketEntity.createdBy.fieldProperties
          in: query
          description: >-
            Field property dictionary mapping field names to field access
            rights.
          required: false
          schema:
            type: object
        - name: mergedTicketEntity.author
          in: query
          description: >-
            A string representing the author of the ticket (same as author of
            first message).
          required: false
          schema:
            type: string
        - name: mergedTicketEntity.ownedBy.associateId
          in: query
          description: Primary key
          required: false
          schema:
            format: int32
            type: integer
        - name: mergedTicketEntity.ownedBy.name
          in: query
          description: Initials, also login name, possibly database user name
          required: false
          schema:
            type: string
        - name: mergedTicketEntity.ownedBy.personId
          in: query
          description: "Owning person record \r\n<para>Use MDO List name \"person\" to get list items.</para>"
          required: false
          schema:
            format: int32
            type: integer
        - name: mergedTicketEntity.ownedBy.rank
          in: query
          description: Rank order
          required: false
          schema:
            format: int32
            type: integer
        - name: mergedTicketEntity.ownedBy.tooltip
          in: query
          description: Tooltip or other description
          required: false
          schema:
            type: string
        - name: mergedTicketEntity.ownedBy.type
          in: query
          description: >-
            User type - 1 = internal user, 2 = resource, 3 = external user, 4 =
            anonymous, 5 = system
          required: false
          schema:
            type: string
            enum:
              - Unknown
              - InternalAssociate
              - ResourceAssociate
              - ExternalAssociate
              - AnonymousAssociate
              - SystemAssociate
        - name: mergedTicketEntity.ownedBy.groupIdx
          in: query
          description: >-
            Primary group membership, see UserGroupLink for secondary
            memberships
          required: false
          schema:
            format: int32
            type: integer
        - name: mergedTicketEntity.ownedBy.fullName
          in: query
          description: >-
            The associate's culture formatted fullname (firstname, middleName
            and lastname)
          required: false
          schema:
            type: string
        - name: mergedTicketEntity.ownedBy.formalName
          in: query
          description: >-
            The associate's culture formatted formalname (firstname, middleName
            and lastname, title, mrmrs)
          required: false
          schema:
            type: string
        - name: mergedTicketEntity.ownedBy.deleted
          in: query
          description: >-
            If true, the user is retired and should have no rights, not appear
            in lists, etc.
          required: false
          schema:
            type: boolean
        - name: mergedTicketEntity.ownedBy.ejUserId
          in: query
          description: >-
            ID of the ej user record corresponding to this associate; 0 for
            associates that are not ej users
          required: false
          schema:
            format: int32
            type: integer
        - name: mergedTicketEntity.ownedBy.userName
          in: query
          description: User name
          required: false
          schema:
            type: string
        - name: mergedTicketEntity.ownedBy.extraFields
          in: query
          description: "Deprecated: Use {SuperOffice.CRM.Services.Associate.CustomFields} instead.\r\nExtra fields added to the carrier. This could be data from Plug-ins, the foreign key system, external applications, etc."
          required: false
          schema:
            type: object
        - name: mergedTicketEntity.ownedBy.customFields
          in: query
          description: "Udef + Extra fields added to the carrier. Extra fields as defined by changes to database schema + user-defined fields as defined by admin.\r\nCustom fields combines user defined fields and extra fields into one bucket. \r\nThe individual {SuperOffice.CRM.Services.Associate.ExtraFields} and <see cref=\"!:UserDefinedFields\">UserDefinedFields</see> properties are deprecated in favor of this\r\ncombined collection."
          required: false
          schema:
            type: object
        - name: mergedTicketEntity.ownedBy.tableRight.mask
          in: query
          required: false
          schema:
            type: string
        - name: mergedTicketEntity.ownedBy.tableRight.reason
          in: query
          required: false
          schema:
            type: string
        - name: mergedTicketEntity.ownedBy.fieldProperties
          in: query
          description: >-
            Field property dictionary mapping field names to field access
            rights.
          required: false
          schema:
            type: object
        - name: mergedTicketEntity.category.ticketCategoryId
          in: query
          description: The id of the ticket category. (primary key)
          required: false
          schema:
            format: int32
            type: integer
        - name: mergedTicketEntity.category.parentId
          in: query
          description: >-
            The parent category for this category. -1 if this is a toplevel
            category.
          required: false
          schema:
            format: int32
            type: integer
        - name: mergedTicketEntity.category.name
          in: query
          description: The (short) name of this category. E.g. &apos;support&apos;.
          required: false
          schema:
            type: string
        - name: mergedTicketEntity.category.fullname
          in: query
          description: >-
            The fullname (compiled from parents&apos; names) for this category.
            E.g. &apos;norway/product A/support&apos;.
          required: false
          schema:
            type: string
        - name: mergedTicketEntity.category.categoryMaster
          in: query
          description: The user associated with this category.
          required: false
          schema:
            format: int32
            type: integer
        - name: mergedTicketEntity.category.flags
          in: query
          description: A bitmask representing flags for this category.
          required: false
          schema:
            type: string
            enum:
              - Unknown
              - Internal
              - OnlyLoggedInUsers
              - DefaultToCategoryMaster
              - ListInMain
              - RedelegateNewMsg
              - DelegateToOurContact
              - PropagateReplyTemplate
              - MembersOnly
              - NotifyMembers
              - AcceptWhenReplying
        - name: mergedTicketEntity.category.delegateMethod
          in: query
          description: An integer indicating the delegation method for this category.
          required: false
          schema:
            type: string
            enum:
              - Unknown
              - Even
              - Weighted
              - Unfair
              - Not
        - name: mergedTicketEntity.category.externalName
          in: query
          description: The external name for this category, used for the customer frontend.
          required: false
          schema:
            type: string
        - name: mergedTicketEntity.category.closingStatus
          in: query
          description: Determines the default status used in the GUI when creating a ticket
          required: false
          schema:
            type: string
            enum:
              - UserDefined
              - Active
              - Closed
              - Postponed
        - name: mergedTicketEntity.category.msgClosingStatus
          in: query
          description: >-
            Determines the default status used in the GUI when adding a request
            to a ticket
          required: false
          schema:
            type: string
            enum:
              - UserDefined
              - Active
              - Closed
              - Postponed
        - name: mergedTicketEntity.category.assignmentLag
          in: query
          description: >-
            Number of minutes we shall override the assignment if a customer
            sends consecutive messages to this category
          required: false
          schema:
            format: int32
            type: integer
        - name: mergedTicketEntity.category.replyTemplate
          in: query
          description: Reply template to merge with messages posted in this category
          required: false
          schema:
            format: int32
            type: integer
        - name: mergedTicketEntity.category.notificationEmail
          in: query
          description: >-
            Comma separated list of addresses to notify when requests are
            redelegated to (unassigned) in this category.
          required: false
          schema:
            type: string
        - name: mergedTicketEntity.category.defaultTicketStatus.ticketStatusId
          in: query
          description: The primary key (auto-incremented)
          required: false
          schema:
            format: int32
            type: integer
        - name: mergedTicketEntity.category.defaultTicketStatus.name
          in: query
          description: Name of user defined ticket status
          required: false
          schema:
            type: string
        - name: mergedTicketEntity.category.defaultTicketStatus.status
          in: query
          description: >-
            The &apos;classic&apos; ticket status. I.e.
            active/closed/postponed/deleted
          required: false
          schema:
            type: string
            enum:
              - Unknown
              - Active
              - Closed
              - Postponed
              - Deleted
              - Merged
              - Spam
              - PostponedSpecific
              - Postponed1Hour
              - Postponed2Hours
              - Postponed3Hours
              - Postponed4Hours
              - PostponedDay
              - PostponedWeek
              - PostponedMonth
        - name: mergedTicketEntity.category.defaultTicketStatus.timeCounter
          in: query
          description: >-
            Which field in ticket we count time spent on (queue, internal,
            external)
          required: false
          schema:
            type: string
            enum:
              - None
              - Internally
              - Externally
              - Queue
        - name: mergedTicketEntity.category.defaultTicketStatus.noEmailReopen
          in: query
          description: Whether inbound emails can reopen requests with this status or not
          required: false
          schema:
            type: boolean
        - name: mergedTicketEntity.category.defaultTicketStatus.isDefault
          in: query
          description: >-
            Indicates if status is default one as there might be more than one
            status with same internal status
          required: false
          schema:
            type: boolean
        - name: mergedTicketEntity.category.defaultTicketStatus.usedInQueue
          in: query
          description: If set, status is used in GetNext calculations
          required: false
          schema:
            type: boolean
        - name: mergedTicketEntity.category.defaultTicketStatus.tableRight.mask
          in: query
          required: false
          schema:
            type: string
        - name: mergedTicketEntity.category.defaultTicketStatus.tableRight.reason
          in: query
          required: false
          schema:
            type: string
        - name: mergedTicketEntity.category.defaultTicketStatus.fieldProperties
          in: query
          description: >-
            Field property dictionary mapping field names to field access
            rights.
          required: false
          schema:
            type: object
        - name: mergedTicketEntity.category.defaultMessageStatus.ticketStatusId
          in: query
          description: The primary key (auto-incremented)
          required: false
          schema:
            format: int32
            type: integer
        - name: mergedTicketEntity.category.defaultMessageStatus.name
          in: query
          description: Name of user defined ticket status
          required: false
          schema:
            type: string
        - name: mergedTicketEntity.category.defaultMessageStatus.status
          in: query
          description: >-
            The &apos;classic&apos; ticket status. I.e.
            active/closed/postponed/deleted
          required: false
          schema:
            type: string
            enum:
              - Unknown
              - Active
              - Closed
              - Postponed
              - Deleted
              - Merged
              - Spam
              - PostponedSpecific
              - Postponed1Hour
              - Postponed2Hours
              - Postponed3Hours
              - Postponed4Hours
              - PostponedDay
              - PostponedWeek
              - PostponedMonth
        - name: mergedTicketEntity.category.defaultMessageStatus.timeCounter
          in: query
          description: >-
            Which field in ticket we count time spent on (queue, internal,
            external)
          required: false
          schema:
            type: string
            enum:
              - None
              - Internally
              - Externally
              - Queue
        - name: mergedTicketEntity.category.defaultMessageStatus.noEmailReopen
          in: query
          description: Whether inbound emails can reopen requests with this status or not
          required: false
          schema:
            type: boolean
        - name: mergedTicketEntity.category.defaultMessageStatus.isDefault
          in: query
          description: >-
            Indicates if status is default one as there might be more than one
            status with same internal status
          required: false
          schema:
            type: boolean
        - name: mergedTicketEntity.category.defaultMessageStatus.usedInQueue
          in: query
          description: If set, status is used in GetNext calculations
          required: false
          schema:
            type: boolean
        - name: mergedTicketEntity.category.defaultMessageStatus.tableRight.mask
          in: query
          required: false
          schema:
            type: string
        - name: mergedTicketEntity.category.defaultMessageStatus.tableRight.reason
          in: query
          required: false
          schema:
            type: string
        - name: mergedTicketEntity.category.defaultMessageStatus.fieldProperties
          in: query
          description: >-
            Field property dictionary mapping field names to field access
            rights.
          required: false
          schema:
            type: object
        - name: mergedTicketEntity.category.effectiveReplyTemplateId
          in: query
          description: >-
            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.
          required: false
          schema:
            format: int32
            type: integer
        - name: mergedTicketEntity.category.extraFields
          in: query
          description: "Deprecated: Use {SuperOffice.CRM.Services.TicketCategoryEntity.CustomFields} instead.\r\nExtra fields added to the carrier. This could be data from Plug-ins, the foreign key system, external applications, etc."
          required: false
          schema:
            type: object
        - name: mergedTicketEntity.category.customFields
          in: query
          description: "Udef + Extra fields added to the carrier. Extra fields as defined by changes to database schema + user-defined fields as defined by admin.\r\nCustom fields combines user defined fields and extra fields into one bucket. \r\nThe individual {SuperOffice.CRM.Services.TicketCategoryEntity.ExtraFields} and <see cref=\"!:UserDefinedFields\">UserDefinedFields</see> properties are deprecated in favor of this\r\ncombined collection."
          required: false
          schema:
            type: object
        - name: mergedTicketEntity.category.tableRight.mask
          in: query
          required: false
          schema:
            type: string
        - name: mergedTicketEntity.category.tableRight.reason
          in: query
          required: false
          schema:
            type: string
        - name: mergedTicketEntity.category.fieldProperties
          in: query
          description: >-
            Field property dictionary mapping field names to field access
            rights.
          required: false
          schema:
            type: object
        - name: mergedTicketEntity.slevel
          in: query
          description: The securitylevel of the ticket.
          required: false
          schema:
            type: string
            enum:
              - Unknown
              - Internal
              - External
        - name: mergedTicketEntity.priority.ticketPriorityId
          in: query
          description: The primary key (auto-incremented)
          required: false
          schema:
            format: int32
            type: integer
        - name: mergedTicketEntity.priority.name
          in: query
          description: The name of the priority.
          required: false
          schema:
            type: string
        - name: mergedTicketEntity.priority.status
          in: query
          description: The status (normal/deleted) of the priority.
          required: false
          schema:
            type: string
            enum:
              - Unknown
              - Normal
              - Deleted
        - name: mergedTicketEntity.priority.flags
          in: query
          description: A bitmask of flags.
          required: false
          schema:
            type: string
            enum:
              - Unknown
              - External
              - Default
              - AlertSchedule
        - name: mergedTicketEntity.priority.sortOrder
          in: query
          description: Indicates the sort order for this priority. 1 is first, 100 is last
          required: false
          schema:
            format: int32
            type: integer
        - name: mergedTicketEntity.priority.ticketRead
          in: query
          description: >-
            This field indicates what to do with the escalation chain when the
            request is read
          required: false
          schema:
            type: string
            enum:
              - None
              - Stop
              - Continue
              - Restart
        - name: mergedTicketEntity.priority.changedOwner
          in: query
          description: >-
            This field indicates what to do with the escalation chain when the
            request changes owner (manually)
          required: false
          schema:
            type: string
            enum:
              - None
              - Stop
              - Continue
              - Restart
        - name: mergedTicketEntity.priority.ticketNewinfo
          in: query
          description: >-
            This field indicates what to do with the escalation chain when the
            request gets new info
          required: false
          schema:
            type: string
            enum:
              - None
              - Stop
              - Continue
              - Restart
        - name: mergedTicketEntity.priority.ticketClosed
          in: query
          description: >-
            This field indicates what to do with the escalation chain when the
            request is closed
          required: false
          schema:
            type: string
            enum:
              - None
              - Stop
              - Continue
              - Restart
        - name: mergedTicketEntity.priority.ticketChangedPriority
          in: query
          description: >-
            This field indicates what to do with the escalation chain when the
            request is changed into this priority
          required: false
          schema:
            type: string
            enum:
              - None
              - Stop
              - Continue
              - Restart
        - name: mergedTicketEntity.priority.ticketNew
          in: query
          description: >-
            This field indicates what to do with the escalation chain when a new
            request is registered
          required: false
          schema:
            type: string
            enum:
              - None
              - Stop
              - Continue
              - Restart
        - name: mergedTicketEntity.priority.deadline
          in: query
          description: Deadline to add if escalated (minutes)
          required: false
          schema:
            format: int32
            type: integer
        - name: mergedTicketEntity.priority.monStart
          in: query
          description: >-
            The work hour start for Mondays. Note that only the time part of the
            DateTime is used
          required: false
          schema:
            format: date-time
            type: string
        - name: mergedTicketEntity.priority.monStop
          in: query
          description: >-
            The work hour start for Mondays. Note that only the time part of the
            DateTime is used
          required: false
          schema:
            format: date-time
            type: string
        - name: mergedTicketEntity.priority.tueStart
          in: query
          description: >-
            The work hour start for Tuesdays. Note that only the time part of
            the DateTime is used
          required: false
          schema:
            format: date-time
            type: string
        - name: mergedTicketEntity.priority.tueStop
          in: query
          description: >-
            The work hour stop for Tuesdays. Note that only the time part of the
            DateTime is used
          required: false
          schema:
            format: date-time
            type: string
        - name: mergedTicketEntity.priority.wedStart
          in: query
          description: >-
            The work hour start for Wednesdays. Note that only the time part of
            the DateTime is used
          required: false
          schema:
            format: date-time
            type: string
        - name: mergedTicketEntity.priority.wedStop
          in: query
          description: >-
            The work hour stop for Wednesdays. Note that only the time part of
            the DateTime is used
          required: false
          schema:
            format: date-time
            type: string
        - name: mergedTicketEntity.priority.thuStart
          in: query
          description: >-
            The work hour start for Thursdays. Note that only the time part of
            the DateTime is used
          required: false
          schema:
            format: date-time
            type: string
        - name: mergedTicketEntity.priority.thuStop
          in: query
          description: >-
            The work hour stop for Thursdays. Note that only the time part of
            the DateTime is used
          required: false
          schema:
            format: date-time
            type: string
        - name: mergedTicketEntity.priority.friStart
          in: query
          description: >-
            The work hour start for Fridays. Note that only the time part of the
            DateTime is used
          required: false
          schema:
            format: date-time
            type: string
        - name: mergedTicketEntity.priority.friStop
          in: query
          description: >-
            The work hour stop for Fridays. Note that only the time part of the
            DateTime is used
          required: false
          schema:
            format: date-time
            type: string
        - name: mergedTicketEntity.priority.satStart
          in: query
          description: >-
            The work hour start for Saturdays. Note that only the time part of
            the DateTime is used
          required: false
          schema:
            format: date-time
            type: string
        - name: mergedTicketEntity.priority.satStop
          in: query
          description: >-
            The work hour stop for Saturdays. Note that only the time part of
            the DateTime is used
          required: false
          schema:
            format: date-time
            type: string
        - name: mergedTicketEntity.priority.sunStart
          in: query
          description: >-
            The work hour start for Sundays. Note that only the time part of the
            DateTime is used
          required: false
          schema:
            format: date-time
            type: string
        - name: mergedTicketEntity.priority.sunStop
          in: query
          description: >-
            The work hour stop for Sundays. Note that only the time part of the
            DateTime is used
          required: false
          schema:
            format: date-time
            type: string
        - name: mergedTicketEntity.priority.nonDates
          in: query
          description: >-
            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
          required: false
          explode: true
          schema:
            type: array
            items:
              format: date-time
              type: string
        - name: mergedTicketEntity.priority.escalationLevels
          in: query
          description: Escalation levels bound to the parent priority
          required: false
          explode: true
          schema:
            type: array
            items: {}
        - name: mergedTicketEntity.priority.tableRight.mask
          in: query
          required: false
          schema:
            type: string
        - name: mergedTicketEntity.priority.tableRight.reason
          in: query
          required: false
          schema:
            type: string
        - name: mergedTicketEntity.priority.fieldProperties
          in: query
          description: >-
            Field property dictionary mapping field names to field access
            rights.
          required: false
          schema:
            type: object
        - name: mergedTicketEntity.baseStatus
          in: query
          description: "The status of the ticket. I.e. active/closed/postponed/deleted \r\n<para>Use MDO List name \"ticketstatus\" to get list items.</para>"
          required: false
          schema:
            type: string
            enum:
              - Unknown
              - Active
              - Closed
              - Postponed
              - Deleted
              - Merged
              - Spam
              - PostponedSpecific
              - Postponed1Hour
              - Postponed2Hours
              - Postponed3Hours
              - Postponed4Hours
              - PostponedDay
              - PostponedWeek
              - PostponedMonth
        - name: mergedTicketEntity.status.ticketStatusId
          in: query
          description: The primary key (auto-incremented)
          required: false
          schema:
            format: int32
            type: integer
        - name: mergedTicketEntity.status.name
          in: query
          description: Name of user defined ticket status
          required: false
          schema:
            type: string
        - name: mergedTicketEntity.status.status
          in: query
          description: >-
            The &apos;classic&apos; ticket status. I.e.
            active/closed/postponed/deleted
          required: false
          schema:
            type: string
            enum:
              - Unknown
              - Active
              - Closed
              - Postponed
              - Deleted
              - Merged
              - Spam
              - PostponedSpecific
              - Postponed1Hour
              - Postponed2Hours
              - Postponed3Hours
              - Postponed4Hours
              - PostponedDay
              - PostponedWeek
              - PostponedMonth
        - name: mergedTicketEntity.status.timeCounter
          in: query
          description: >-
            Which field in ticket we count time spent on (queue, internal,
            external)
          required: false
          schema:
            type: string
            enum:
              - None
              - Internally
              - Externally
              - Queue
        - name: mergedTicketEntity.status.noEmailReopen
          in: query
          description: Whether inbound emails can reopen requests with this status or not
          required: false
          schema:
            type: boolean
        - name: mergedTicketEntity.status.isDefault
          in: query
          description: >-
            Indicates if status is default one as there might be more than one
            status with same internal status
          required: false
          schema:
            type: boolean
        - name: mergedTicketEntity.status.usedInQueue
          in: query
          description: If set, status is used in GetNext calculations
          required: false
          schema:
            type: boolean
        - name: mergedTicketEntity.status.tableRight.mask
          in: query
          required: false
          schema:
            type: string
        - name: mergedTicketEntity.status.tableRight.reason
          in: query
          required: false
          schema:
            type: string
        - name: mergedTicketEntity.status.fieldProperties
          in: query
          description: >-
            Field property dictionary mapping field names to field access
            rights.
          required: false
          schema:
            type: object
        - name: mergedTicketEntity.origin
          in: query
          description: What is the origin of this ticket
          required: false
          schema:
            type: string
            enum:
              - Unknown
              - Email
              - SMS
              - Fax
              - Phone
              - Facebook
              - Twitter
              - Internal
              - CustomerCentre
              - EMarketing
              - AutoGenerated
              - Chat
              - Form
              - API
              - Flow
        - name: mergedTicketEntity.person.position
          in: query
          description: >-
            The position. This is a predefined SuperOffice value, different from
            Title
          required: false
          schema:
            type: string
        - name: mergedTicketEntity.person.personId
          in: query
          description: Primary key
          required: false
          schema:
            format: int32
            type: integer
        - name: mergedTicketEntity.person.mrmrs
          in: query
          description: e.g. Mrs   sex_title
          required: false
          schema:
            type: string
        - name: mergedTicketEntity.person.firstname
          in: query
          description: First name
          required: false
          schema:
            type: string
        - name: mergedTicketEntity.person.lastname
          in: query
          description: Last name
          required: false
          schema:
            type: string
        - name: mergedTicketEntity.person.middleName
          in: query
          description: Middle name or 'van' etc.
          required: false
          schema:
            type: string
        - name: mergedTicketEntity.person.title
          in: query
          description: Title
          required: false
          schema:
            type: string
        - name: mergedTicketEntity.person.description
          in: query
          description: Info text/description on person.
          required: false
          schema:
            type: string
        - name: mergedTicketEntity.person.email
          in: query
          description: First email on contact person.
          required: false
          schema:
            type: string
        - name: mergedTicketEntity.person.fullName
          in: query
          description: >-
            Get the persons full name (internal name used in clients for
            employees).
          required: false
          schema:
            type: string
        - name: mergedTicketEntity.person.directPhone
          in: query
          description: Returns the direct phone that belong to the contact person.
          required: false
          schema:
            type: string
        - name: mergedTicketEntity.person.formalName
          in: query
          description: >-
            Get formal name for a person, as used in labels. (Full name + person
            title + academic title)
          required: false
          schema:
            type: string
        - name: mergedTicketEntity.person.countryId
          in: query
          description: Country
          required: false
          schema:
            format: int32
            type: integer
        - name: mergedTicketEntity.person.contactId
          in: query
          description: Owning contact ID
          required: false
          schema:
            format: int32
            type: integer
        - name: mergedTicketEntity.person.contactName
          in: query
          description: The persons company name
          required: false
          schema:
            type: string
        - name: mergedTicketEntity.person.retired
          in: query
          description: >-
            1 = the user is retired and should have no rights, not appear in
            lists, etc.
          required: false
          schema:
            format: int32
            type: integer
        - name: mergedTicketEntity.person.rank
          in: query
          description: Display sort sequence for default sort order
          required: false
          schema:
            format: int32
            type: integer
        - name: mergedTicketEntity.person.activeInterests
          in: query
          description: >-
            Number of records in pintr table; select count(*) from pintr pi
            where pi.person_id = this.person_id == activeInterests is always
            true
          required: false
          schema:
            format: int32
            type: integer
        - name: mergedTicketEntity.person.contactDepartment
          in: query
          description: The persons contact department
          required: false
          schema:
            type: string
        - name: mergedTicketEntity.person.contactCountryId
          in: query
          description: The persons contact country id
          required: false
          schema:
            format: int32
            type: integer
        - name: mergedTicketEntity.person.contactOrgNr
          in: query
          description: The persons contact organization number
          required: false
          schema:
            type: string
        - name: mergedTicketEntity.person.faxPhone
          in: query
          description: Returns the fax phone that belong to the contact person.
          required: false
          schema:
            type: string
        - name: mergedTicketEntity.person.mobilePhone
          in: query
          description: Returns the mobile phone that belong to the contact person.
          required: false
          schema:
            type: string
        - name: mergedTicketEntity.person.contactPhone
          in: query
          description: Returns the direct phone that belong to the persons contact.
          required: false
          schema:
            type: string
        - name: mergedTicketEntity.person.associateName
          in: query
          description: Name of the person's owner
          required: false
          schema:
            type: string
        - name: mergedTicketEntity.person.associateId
          in: query
          description: Id of the item's owner (Associate id)
          required: false
          schema:
            format: int32
            type: integer
        - name: mergedTicketEntity.person.usePersonAddress
          in: query
          description: If 1, use person's address for mailing instead of company address
          required: false
          schema:
            type: boolean
        - name: mergedTicketEntity.person.contactFax
          in: query
          description: Actual phone number as eneterd by the user
          required: false
          schema:
            type: string
        - name: mergedTicketEntity.person.kanafname
          in: query
          description: Kana first name, used in Japanese versions only
          required: false
          schema:
            type: string
        - name: mergedTicketEntity.person.kanalname
          in: query
          description: Kana last name, used in Japanese versions only
          required: false
          schema:
            type: string
        - name: mergedTicketEntity.person.post1
          in: query
          description: Postal address, used in Japanese versions only
          required: false
          schema:
            type: string
        - name: mergedTicketEntity.person.post2
          in: query
          description: Postal address, used in Japanese versions only
          required: false
          schema:
            type: string
        - name: mergedTicketEntity.person.post3
          in: query
          description: Postal address, used in Japanese versions only
          required: false
          schema:
            type: string
        - name: mergedTicketEntity.person.emailName
          in: query
          description: E-mail description
          required: false
          schema:
            type: string
        - name: mergedTicketEntity.person.contactFullName
          in: query
          description: Company full name + department
          required: false
          schema:
            type: string
        - name: mergedTicketEntity.person.activeErpLinks
          in: query
          description: How many active ERP links are there for this person?
          required: false
          schema:
            format: int32
            type: integer
        - name: mergedTicketEntity.person.ticketPriorityId
          in: query
          description: Ticket priority ID
          required: false
          schema:
            format: int32
            type: integer
        - name: mergedTicketEntity.person.supportLanguageId
          in: query
          description: Support priority ID
          required: false
          schema:
            format: int32
            type: integer
        - name: mergedTicketEntity.person.supportAssociateId
          in: query
          description: Our support contact for this person
          required: false
          schema:
            format: int32
            type: integer
        - name: mergedTicketEntity.person.categoryName
          in: query
          description: The category list item name
          required: false
          schema:
            type: string
        - name: mergedTicketEntity.person.personNumber
          in: query
          description: Alphanumeric user field
          required: false
          schema:
            type: string
        - name: mergedTicketEntity.person.tableRight.mask
          in: query
          required: false
          schema:
            type: string
        - name: mergedTicketEntity.person.tableRight.reason
          in: query
          required: false
          schema:
            type: string
        - name: mergedTicketEntity.person.fieldProperties
          in: query
          description: >-
            Field property dictionary mapping field names to field access
            rights.
          required: false
          schema:
            type: object
        - name: mergedTicketEntity.secondaryPersons
          in: query
          description: "The secondary persons this ticket is connected to \r\n<para>Use MDO List name \"person_new\" to get list items.</para>"
          required: false
          explode: true
          schema:
            type: array
            items: {}
        - name: mergedTicketEntity.alertLevel
          in: query
          description: >-
            The alert level for the ticket. Matches the level value of the
            ticket_alert table.
          required: false
          schema:
            format: int32
            type: integer
        - name: mergedTicketEntity.connectId
          in: query
          description: >-
            If a ticket is connected to another ticket, this field is set to the
            id of the &apos;master&apos; ticket.
          required: false
          schema:
            format: int32
            type: integer
        - name: mergedTicketEntity.readStatus
          in: query
          description: Whether the owner has read the ticket or not (red, yellow, green).
          required: false
          schema:
            type: string
            enum:
              - Unknown
              - Green
              - Yellow
              - Red
        - name: mergedTicketEntity.timeToReply
          in: query
          description: >-
            The time (minutes) between when the ticket was created and when it
            was replied to. Calculated based on priority&apos;s timeframe.
          required: false
          schema:
            format: int32
            type: integer
        - name: mergedTicketEntity.realTimeToReply
          in: query
          description: Same as time_to_reply, but not calculated based on priority.
          required: false
          schema:
            format: int32
            type: integer
        - name: mergedTicketEntity.timeToClose
          in: query
          description: >-
            The time (minutes) between when the ticket was created and when it
            was closed. Calculated based on priority&apos;s timeframe.
          required: false
          schema:
            format: int32
            type: integer
        - name: mergedTicketEntity.realTimeToClose
          in: query
          description: Same as time_to_close, but not calculated based on priority.
          required: false
          schema:
            format: int32
            type: integer
        - name: mergedTicketEntity.timeSpentInternally
          in: query
          description: >-
            The total time (seconds) within the priority's office hours the
            ticket has been in an open status (configurable), not including
            current state
          required: false
          schema:
            format: int32
            type: integer
        - name: mergedTicketEntity.timeSpentExternally
          in: query
          description: >-
            The total time (seconds) within the priority's office hours the
            ticket has been in a external waiting status (configurable), not
            including current state
          required: false
          schema:
            format: int32
            type: integer
        - name: mergedTicketEntity.timeSpentQueue
          in: query
          description: >-
            The total time (seconds) within the priority's office hours the
            ticket has been in a queue status, not including current state
          required: false
          schema:
            format: int32
            type: integer
        - name: mergedTicketEntity.realTimeSpentInternally
          in: query
          description: >-
            The total time (seconds) within 24x7 the ticket has been in an open
            status (configurable), not including current state
          required: false
          schema:
            format: int32
            type: integer
        - name: mergedTicketEntity.realTimeSpentExternally
          in: query
          description: >-
            The total time (seconds) within 24x7 the ticket has been in a
            external waiting status (configurable), not including current state
          required: false
          schema:
            format: int32
            type: integer
        - name: mergedTicketEntity.realTimeSpentQueue
          in: query
          description: >-
            The total time (seconds) within 24x7 hours the ticket has been in a
            queue status, not including current state
          required: false
          schema:
            format: int32
            type: integer
        - name: mergedTicketEntity.timeSpent
          in: query
          description: >-
            The total time (minutes). Aggregated time spent from ticket&apos;s
            messages. Read-only for external use.
          required: false
          schema:
            format: int32
            type: integer
        - name: mergedTicketEntity.hasAttachment
          in: query
          description: Boolean indicating if this ticket has one or more attachments.
          required: false
          schema:
            type: boolean
        - name: mergedTicketEntity.numReplies
          in: query
          description: The number of replies (messages) to the customer for this request.
          required: false
          schema:
            format: int32
            type: integer
        - name: mergedTicketEntity.numMessages
          in: query
          description: The total number of messages for this request.
          required: false
          schema:
            format: int32
            type: integer
        - name: mergedTicketEntity.fromAddress
          in: query
          description: The from-address used when this ticket got created, e.g. by email
          required: false
          schema:
            type: string
        - name: mergedTicketEntity.messages
          in: query
          description: >-
            TicketMessageId,CreatedAt,SLevel and Important for all the messages
            connected to this ticket. For message body see the
            TicketMessageEntity or the TicketMessage archive.
          required: false
          explode: true
          schema:
            type: array
            items: {}
        - name: mergedTicketEntity.tags
          in: query
          description: An array containing the tags assigned to this request
          required: false
          explode: true
          schema:
            type: array
            items: {}
        - name: mergedTicketEntity.language
          in: query
          description: The language of the first external message
          required: false
          schema:
            type: string
        - name: mergedTicketEntity.sentiment
          in: query
          description: The sentiment index of the last external message
          required: false
          schema:
            format: int32
            type: integer
        - name: mergedTicketEntity.sentimentConfidence
          in: query
          description: The sentiment confidence of the last external message
          required: false
          schema:
            format: int32
            type: integer
        - name: mergedTicketEntity.suggestedCategoryId
          in: query
          description: Suggestion for categorization, based on the text of the message (AI)
          required: false
          schema:
            format: int32
            type: integer
        - name: mergedTicketEntity.suggestedCategoryName
          in: query
          description: Suggested category from AI
          required: false
          schema:
            type: string
        - name: mergedTicketEntity.origHumanCategoryId
          in: query
          description: >-
            Will contain the category id selected by the user, when having the
            choice of using the suggested category or manually selecting a
            category
          required: false
          schema:
            format: int32
            type: integer
        - name: mergedTicketEntity.iconHint
          in: query
          description: Icon representing ticket's state
          required: false
          schema:
            type: string
        - name: mergedTicketEntity.sale.contactName
          in: query
          description: Contact name
          required: false
          schema:
            type: string
        - name: mergedTicketEntity.sale.saleDate
          in: query
          description: (expected / lost / won) sales date
          required: false
          schema:
            format: date-time
            type: string
        - name: mergedTicketEntity.sale.saleId
          in: query
          description: Primary key
          required: false
          schema:
            format: int32
            type: integer
        - name: mergedTicketEntity.sale.probability
          in: query
          description: Actual probability, may differ from the one in the list
          required: false
          schema:
            format: int32
            type: integer
        - name: mergedTicketEntity.sale.title
          in: query
          description: Sale heading (short description?)
          required: false
          schema:
            type: string
        - name: mergedTicketEntity.sale.amount
          in: query
          description: Total sale amount
          required: false
          schema:
            type: number
            format: double
        - name: mergedTicketEntity.sale.currency
          in: query
          description: Currency the sale was made in.
          required: false
          schema:
            type: string
        - name: mergedTicketEntity.sale.projectName
          in: query
          description: Project name
          required: false
          schema:
            type: string
        - name: mergedTicketEntity.sale.associateFullName
          in: query
          description: The sale's owner
          required: false
          schema:
            type: string
        - name: mergedTicketEntity.sale.description
          in: query
          description: The sales description
          required: false
          schema:
            type: string
        - name: mergedTicketEntity.sale.status
          in: query
          description: The sale's status, indicating wether the sale is open, sold or lost.
          required: false
          schema:
            type: string
            enum:
              - Unknown
              - Open
              - Sold
              - Lost
              - Stalled
              - SaintAll
        - name: mergedTicketEntity.sale.weightedAmount
          in: query
          description: The weighted amount ( amount *  probability / 100)
          required: false
          schema:
            type: number
            format: double
        - name: mergedTicketEntity.sale.projectId
          in: query
          description: Optional project reference
          required: false
          schema:
            format: int32
            type: integer
        - name: mergedTicketEntity.sale.earningPercent
          in: query
          description: Earning as percent of total
          required: false
          schema:
            type: number
            format: double
        - name: mergedTicketEntity.sale.earning
          in: query
          description: Earning on sale
          required: false
          schema:
            type: number
            format: double
        - name: mergedTicketEntity.sale.contactId
          in: query
          description: Optional contact reference
          required: false
          schema:
            format: int32
            type: integer
        - name: mergedTicketEntity.sale.associateId
          in: query
          description: The sale's owner id
          required: false
          schema:
            format: int32
            type: integer
        - name: mergedTicketEntity.sale.personId
          in: query
          description: The sale's contact persons id
          required: false
          schema:
            format: int32
            type: integer
        - name: mergedTicketEntity.sale.saleTypeId
          in: query
          description: The sale's type id
          required: false
          schema:
            format: int32
            type: integer
        - name: mergedTicketEntity.sale.saleTypeName
          in: query
          description: The sale's type name
          required: false
          schema:
            type: string
        - name: mergedTicketEntity.sale.personFullName
          in: query
          description: The name of the person this sale belongs to.
          required: false
          schema:
            type: string
        - name: mergedTicketEntity.sale.completed
          in: query
          description: >-
            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.
          required: false
          schema:
            type: string
            enum:
              - Unknown
              - NotStarted
              - Started
              - Completed
        - name: mergedTicketEntity.sale.activeErpLinks
          in: query
          description: The number of active erp links
          required: false
          schema:
            format: int32
            type: integer
        - name: mergedTicketEntity.sale.nextDueDate
          in: query
          description: >-
            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.
          required: false
          schema:
            format: date-time
            type: string
        - name: mergedTicketEntity.sale.number
          in: query
          description: Alphanumeric user field
          required: false
          schema:
            type: string
        - name: mergedTicketEntity.sale.tableRight.mask
          in: query
          required: false
          schema:
            type: string
        - name: mergedTicketEntity.sale.tableRight.reason
          in: query
          required: false
          schema:
            type: string
        - name: mergedTicketEntity.sale.fieldProperties
          in: query
          description: >-
            Field property dictionary mapping field names to field access
            rights.
          required: false
          schema:
            type: object
        - name: mergedTicketEntity.project.projectId
          in: query
          description: Primary key
          required: false
          schema:
            format: int32
            type: integer
        - name: mergedTicketEntity.project.name
          in: query
          description: Project name
          required: false
          schema:
            type: string
        - name: mergedTicketEntity.project.description
          in: query
          description: The projects description
          required: false
          schema:
            type: string
        - name: mergedTicketEntity.project.uRL
          in: query
          description: URL address
          required: false
          schema:
            type: string
        - name: mergedTicketEntity.project.type
          in: query
          description: The project type.
          required: false
          schema:
            type: string
        - name: mergedTicketEntity.project.associateId
          in: query
          description: The project owner id (associate id)
          required: false
          schema:
            format: int32
            type: integer
        - name: mergedTicketEntity.project.associateFullName
          in: query
          description: The project owner
          required: false
          schema:
            type: string
        - name: mergedTicketEntity.project.typeId
          in: query
          description: ''
          required: false
          schema:
            format: int32
            type: integer
        - name: mergedTicketEntity.project.updated
          in: query
          description: Last updated date  in UTC.
          required: false
          schema:
            format: date-time
            type: string
        - name: mergedTicketEntity.project.statusId
          in: query
          description: The projects status id
          required: false
          schema:
            format: int32
            type: integer
        - name: mergedTicketEntity.project.status
          in: query
          description: The projects status
          required: false
          schema:
            type: string
        - name: mergedTicketEntity.project.textId
          in: query
          description: The id of the description
          required: false
          schema:
            format: int32
            type: integer
        - name: mergedTicketEntity.project.publishTo
          in: query
          description: Publication valid to (inclusive)
          required: false
          schema:
            format: date-time
            type: string
        - name: mergedTicketEntity.project.publishFrom
          in: query
          description: Publication valid from (inclusive)
          required: false
          schema:
            format: date-time
            type: string
        - name: mergedTicketEntity.project.isPublished
          in: query
          description: ''
          required: false
          schema:
            type: boolean
        - name: mergedTicketEntity.project.uRLName
          in: query
          description: Visible field
          required: false
          schema:
            type: string
        - name: mergedTicketEntity.project.projectNumber
          in: query
          description: Automatically generated number
          required: false
          schema:
            type: string
        - name: mergedTicketEntity.project.activeErpLinks
          in: query
          description: The number of active erp links
          required: false
          schema:
            format: int32
            type: integer
        - name: mergedTicketEntity.project.eventId
          in: query
          description: Reserved field for Lyyti event when project is linked to an event.
          required: false
          schema:
            format: int32
            type: integer
        - name: mergedTicketEntity.project.startDate
          in: query
          description: >-
            Reserved field for Lyyti event when project is linked to an event,
            is the event start date.
          required: false
          schema:
            format: date-time
            type: string
        - name: mergedTicketEntity.project.tableRight.mask
          in: query
          required: false
          schema:
            type: string
        - name: mergedTicketEntity.project.tableRight.reason
          in: query
          required: false
          schema:
            type: string
        - name: mergedTicketEntity.project.fieldProperties
          in: query
          description: >-
            Field property dictionary mapping field names to field access
            rights.
          required: false
          schema:
            type: object
        - name: mergedTicketEntity.formSubmission.formSubmissionId
          in: query
          description: Primary key
          required: false
          schema:
            format: int32
            type: integer
        - name: mergedTicketEntity.formSubmission.emailAddress
          in: query
          description: The email address of the person who submitted
          required: false
          schema:
            type: string
        - name: mergedTicketEntity.formSubmission.status
          in: query
          description: What is the status of this submission
          required: false
          schema:
            type: string
            enum:
              - Unknown
              - InProgress
              - EmailVerification
              - Submitted
              - Processed
              - Failed
        - name: mergedTicketEntity.ticketType.ticketTypeId
          in: query
          description: Primary key
          required: false
          schema:
            format: int32
            type: integer
        - name: mergedTicketEntity.ticketType.name
          in: query
          description: The list item
          required: false
          schema:
            type: string
        - name: mergedTicketEntity.ticketType.icon
          in: query
          description: Name of the icon
          required: false
          schema:
            type: string
        - name: mergedTicketEntity.ticketType.defaultTicketStatus
          in: query
          description: Default ticket status for new tickets
          required: false
          schema:
            format: int32
            type: integer
        - name: mergedTicketEntity.ticketType.defaultTicketPriority
          in: query
          description: Default ticket priority for new tickets
          required: false
          schema:
            format: int32
            type: integer
        - name: mergedTicketEntity.ticketType.isDefault
          in: query
          description: Is this Ticket Type marked as default
          required: false
          schema:
            type: boolean
        - name: mergedTicketEntity.ticketType.showInNew
          in: query
          description: Enables this request type to be accessible in +New in top bar
          required: false
          schema:
            type: boolean
        - name: mergedTicketEntity.ticketType.excludeSignature
          in: query
          description: Do not insert user signature automatically
          required: false
          schema:
            type: boolean
        - name: mergedTicketEntity.ticketType.excludeEmailRecipients
          in: query
          description: Create request without initially having to send outbound e-mail
          required: false
          schema:
            type: boolean
        - name: mergedTicketEntity.ticketType.externalAsDefault
          in: query
          description: Ability to set external access level for this request type
          required: false
          schema:
            type: boolean
        - name: mergedTicketEntity.ticketType.visibleForGroups
          in: query
          description: Array of references to the visible for groups
          required: false
          explode: true
          schema:
            type: array
            items:
              format: int32
              type: integer
        - name: mergedTicketEntity.ticketType.replyForwardNoSignature
          in: query
          description: Do not insert user signature when replying or forwarding the message
          required: false
          schema:
            type: boolean
        - name: mergedTicketEntity.ticketType.replyExternalAsDefault
          in: query
          description: Set external access level when replying the message
          required: false
          schema:
            type: boolean
        - name: mergedTicketEntity.ticketType.tableRight.mask
          in: query
          required: false
          schema:
            type: string
        - name: mergedTicketEntity.ticketType.tableRight.reason
          in: query
          required: false
          schema:
            type: string
        - name: mergedTicketEntity.ticketType.fieldProperties
          in: query
          description: >-
            Field property dictionary mapping field names to field access
            rights.
          required: false
          schema:
            type: object
        - name: mergedTicketEntity.activeStatusMonitorId
          in: query
          description: >-
            Active status monitor identity for related contact. This is a
            read-only property and is ignored on Save
          required: false
          schema:
            format: int32
            type: integer
        - name: mergedTicketEntity.extraFields
          in: query
          description: "Deprecated: Use {SuperOffice.CRM.Services.TicketEntity.CustomFields} instead.\r\nExtra fields added to the carrier. This could be data from Plug-ins, the foreign key system, external applications, etc."
          required: false
          schema:
            type: object
        - name: mergedTicketEntity.customFields
          in: query
          description: "Udef + Extra fields added to the carrier. Extra fields as defined by changes to database schema + user-defined fields as defined by admin.\r\nCustom fields combines user defined fields and extra fields into one bucket. \r\nThe individual {SuperOffice.CRM.Services.TicketEntity.ExtraFields} and <see cref=\"!:UserDefinedFields\">UserDefinedFields</see> properties are deprecated in favor of this\r\ncombined collection."
          required: false
          schema:
            type: object
        - name: mergedTicketEntity.tableRight.mask
          in: query
          required: false
          schema:
            type: string
        - name: mergedTicketEntity.tableRight.reason
          in: query
          required: false
          schema:
            type: string
        - name: mergedTicketEntity.fieldProperties
          in: query
          description: >-
            Field property dictionary mapping field names to field access
            rights.
          required: false
          schema:
            type: object
        - name: Accept-Language
          in: header
          description: >-
            Convert string references and multi-language values into a specified
            language (iso2) code.
          required: false
          schema:
            type: string
        - name: SO-Language
          in: header
          description: >-
            Convert string references and multi-language values into a specified
            language (iso2) code. Overrides Accept-Language value.
          required: false
          schema:
            type: string
        - name: SO-Culture
          in: header
          description: >-
            Number, date formatting in a specified culture (iso2 language) code.
            Partially overrides SO-Language/Accept-Language value. Ignored if no
            Language set.
          required: false
          schema:
            type: string
        - name: SO-TimeZone
          in: header
          description: >-
            Specify the timezone code that you would like date/time responses
            converted to.
          required: false
          schema:
            type: string
        - name: SO-AppToken
          in: header
          description: >-
            The application token that identifies the partner app. Used when
            calling Online WebAPI from a server.
          required: false
          schema:
            type: string
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/SuperOffice.CRM.Services.TicketEntity'
            text/json:
              schema:
                $ref: '#/components/schemas/SuperOffice.CRM.Services.TicketEntity'
            application/xml:
              schema:
                $ref: '#/components/schemas/SuperOffice.CRM.Services.TicketEntity'
            text/xml:
              schema:
                $ref: '#/components/schemas/SuperOffice.CRM.Services.TicketEntity'
            application/json-patch+json:
              schema:
                $ref: '#/components/schemas/SuperOffice.CRM.Services.TicketEntity'
            application/merge-patch+json:
              schema:
                $ref: '#/components/schemas/SuperOffice.CRM.Services.TicketEntity'
      security:
        - SuperOffice_Password: []
          SuperId_Authentication: []
components:
  schemas:
    SuperOffice.CRM.Services.TicketEntity:
      description: "The ticket entity is used for representing a service ticket\r\n<para />\r\nCarrier object for TicketEntity.\r\nServices for the TicketEntity Carrier is available from the <see cref=\"T:SuperOffice.CRM.Services.ITicketAgent\">Ticket Agent</see>."
      type: object
      properties:
        TicketId:
          format: int32
          description: The primary key (auto-incremented)
          type: integer
        Title:
          description: The title of the ticket.
          type: string
        CreatedAt:
          format: date-time
          description: When the ticket was created.
          type: string
        LastChanged:
          format: date-time
          description: The last time the ticket was modified.
          type: string
        ReadByOwner:
          format: date-time
          description: The datetime for when the ticket last was read by the owner.
          type: string
        ReadByCustomer:
          format: date-time
          description: The datetime for when the ticket was read by the customer.
          type: string
        FirstReadByOwner:
          format: date-time
          description: >-
            The datetime for when the ticket first was read by the current
            owner.
          type: string
        FirstReadByUser:
          format: date-time
          description: The datetime for when the ticket first was read by a user.
          type: string
        Activate:
          format: date-time
          description: When the ticket should be activated, if it is postponed.
          type: string
        ClosedAt:
          format: date-time
          description: When the ticket was closed.
          type: string
        RepliedAt:
          format: date-time
          description: >-
            The datetime for when the ticket was replied to. I.e. the first
            external message added to the ticket.
          type: string
        AlertTimeout:
          format: date-time
          description: >-
            The datetime for when the ticket should jump to the next
            alert_level.
          type: string
        Deadline:
          format: date-time
          description: Deadline for ticket.
          type: string
        CreatedBy:
          $ref: '#/components/schemas/SuperOffice.CRM.Services.Associate'
        Author:
          description: >-
            A string representing the author of the ticket (same as author of
            first message).
          type: string
        OwnedBy:
          $ref: '#/components/schemas/SuperOffice.CRM.Services.Associate'
        Category:
          $ref: '#/components/schemas/SuperOffice.CRM.Services.TicketCategoryEntity'
        Slevel:
          description: The securitylevel of the ticket.
          enum:
            - Unknown
            - Internal
            - External
          type: string
        Priority:
          $ref: '#/components/schemas/SuperOffice.CRM.Services.TicketPriorityEntity'
        BaseStatus:
          description: "The status of the ticket. I.e. active/closed/postponed/deleted \r\n<para>Use MDO List name \"ticketstatus\" to get list items.</para>"
          enum:
            - Unknown
            - Active
            - Closed
            - Postponed
            - Deleted
            - Merged
            - Spam
            - PostponedSpecific
            - Postponed1Hour
            - Postponed2Hours
            - Postponed3Hours
            - Postponed4Hours
            - PostponedDay
            - PostponedWeek
            - PostponedMonth
          type: string
        Status:
          $ref: '#/components/schemas/SuperOffice.CRM.Services.TicketStatusEntity'
        Origin:
          description: What is the origin of this ticket
          enum:
            - Unknown
            - Email
            - SMS
            - Fax
            - Phone
            - Facebook
            - Twitter
            - Internal
            - CustomerCentre
            - EMarketing
            - AutoGenerated
            - Chat
            - Form
            - API
            - Flow
          type: string
        Person:
          $ref: '#/components/schemas/SuperOffice.CRM.Services.Person'
        SecondaryPersons:
          description: "The secondary persons this ticket is connected to \r\n<para>Use MDO List name \"person_new\" to get list items.</para>"
          type: array
          items:
            $ref: '#/components/schemas/SuperOffice.CRM.Services.Person'
        AlertLevel:
          format: int32
          description: >-
            The alert level for the ticket. Matches the level value of the
            ticket_alert table.
          type: integer
        ConnectId:
          format: int32
          description: >-
            If a ticket is connected to another ticket, this field is set to the
            id of the &apos;master&apos; ticket.
          type: integer
        ReadStatus:
          description: Whether the owner has read the ticket or not (red, yellow, green).
          enum:
            - Unknown
            - Green
            - Yellow
            - Red
          type: string
        TimeToReply:
          format: int32
          description: >-
            The time (minutes) between when the ticket was created and when it
            was replied to. Calculated based on priority&apos;s timeframe.
          type: integer
        RealTimeToReply:
          format: int32
          description: Same as time_to_reply, but not calculated based on priority.
          type: integer
        TimeToClose:
          format: int32
          description: >-
            The time (minutes) between when the ticket was created and when it
            was closed. Calculated based on priority&apos;s timeframe.
          type: integer
        RealTimeToClose:
          format: int32
          description: Same as time_to_close, but not calculated based on priority.
          type: integer
        TimeSpentInternally:
          format: int32
          description: >-
            The total time (seconds) within the priority's office hours the
            ticket has been in an open status (configurable), not including
            current state
          type: integer
        TimeSpentExternally:
          format: int32
          description: >-
            The total time (seconds) within the priority's office hours the
            ticket has been in a external waiting status (configurable), not
            including current state
          type: integer
        TimeSpentQueue:
          format: int32
          description: >-
            The total time (seconds) within the priority's office hours the
            ticket has been in a queue status, not including current state
          type: integer
        RealTimeSpentInternally:
          format: int32
          description: >-
            The total time (seconds) within 24x7 the ticket has been in an open
            status (configurable), not including current state
          type: integer
        RealTimeSpentExternally:
          format: int32
          description: >-
            The total time (seconds) within 24x7 the ticket has been in a
            external waiting status (configurable), not including current state
          type: integer
        RealTimeSpentQueue:
          format: int32
          description: >-
            The total time (seconds) within 24x7 hours the ticket has been in a
            queue status, not including current state
          type: integer
        TimeSpent:
          format: int32
          description: >-
            The total time (minutes). Aggregated time spent from ticket&apos;s
            messages. Read-only for external use.
          type: integer
        HasAttachment:
          description: Boolean indicating if this ticket has one or more attachments.
          type: boolean
        NumReplies:
          format: int32
          description: The number of replies (messages) to the customer for this request.
          type: integer
        NumMessages:
          format: int32
          description: The total number of messages for this request.
          type: integer
        FromAddress:
          description: The from-address used when this ticket got created, e.g. by email
          type: string
        Messages:
          description: >-
            TicketMessageId,CreatedAt,SLevel and Important for all the messages
            connected to this ticket. For message body see the
            TicketMessageEntity or the TicketMessage archive.
          type: array
          items:
            $ref: '#/components/schemas/SuperOffice.CRM.Services.TicketMessage'
        Tags:
          description: An array containing the tags assigned to this request
          type: array
          items:
            $ref: '#/components/schemas/SuperOffice.CRM.Services.Tag'
        Language:
          description: The language of the first external message
          type: string
        Sentiment:
          format: int32
          description: The sentiment index of the last external message
          type: integer
        SentimentConfidence:
          format: int32
          description: The sentiment confidence of the last external message
          type: integer
        SuggestedCategoryId:
          format: int32
          description: Suggestion for categorization, based on the text of the message (AI)
          type: integer
        SuggestedCategoryName:
          description: Suggested category from AI
          type: string
        OrigHumanCategoryId:
          format: int32
          description: >-
            Will contain the category id selected by the user, when having the
            choice of using the suggested category or manually selecting a
            category
          type: integer
        IconHint:
          description: Icon representing ticket's state
          type: string
        Sale:
          $ref: '#/components/schemas/SuperOffice.CRM.Services.Sale'
        Project:
          $ref: '#/components/schemas/SuperOffice.CRM.Services.Project'
        FormSubmission:
          $ref: '#/components/schemas/SuperOffice.CRM.Services.TicketFormSubmission'
        TicketType:
          $ref: '#/components/schemas/SuperOffice.CRM.Services.TicketType'
        ActiveStatusMonitorId:
          format: int32
          description: >-
            Active status monitor identity for related contact. This is a
            read-only property and is ignored on Save
          type: integer
        ExtraFields:
          description: "Deprecated: Use {SuperOffice.CRM.Services.TicketEntity.CustomFields} instead.\r\nExtra fields added to the carrier. This could be data from Plug-ins, the foreign key system, external applications, etc."
          type: object
          additionalProperties:
            type: string
        CustomFields:
          description: "Udef + Extra fields added to the carrier. Extra fields as defined by changes to database schema + user-defined fields as defined by admin.\r\nCustom fields combines user defined fields and extra fields into one bucket. \r\nThe individual {SuperOffice.CRM.Services.TicketEntity.ExtraFields} and <see cref=\"!:UserDefinedFields\">UserDefinedFields</see> properties are deprecated in favor of this\r\ncombined collection."
          type: object
          additionalProperties:
            type: string
        TableRight:
          $ref: '#/components/schemas/SuperOffice.CRM.Security.TableRight'
        FieldProperties:
          description: >-
            Field property dictionary mapping field names to field access
            rights.
          type: object
          additionalProperties:
            $ref: '#/components/schemas/SuperOffice.CRM.Security.FieldProperty'
    SuperOffice.CRM.Services.Associate:
      description: "Carrier object for Associate.\r\nServices for the Associate Carrier is available from the <see cref=\"T:SuperOffice.CRM.Services.IAssociateAgent\">Associate Agent</see>."
      type: object
      properties:
        AssociateId:
          format: int32
          description: Primary key
          type: integer
        Name:
          description: Initials, also login name, possibly database user name
          type: string
        PersonId:
          format: int32
          description: "Owning person record \r\n<para>Use MDO List name \"person\" to get list items.</para>"
          type: integer
        Rank:
          format: int32
          description: Rank order
          type: integer
        Tooltip:
          description: Tooltip or other description
          type: string
        Type:
          description: >-
            User type - 1 = internal user, 2 = resource, 3 = external user, 4 =
            anonymous, 5 = system
          enum:
            - Unknown
            - InternalAssociate
            - ResourceAssociate
            - ExternalAssociate
            - AnonymousAssociate
            - SystemAssociate
          type: string
        GroupIdx:
          format: int32
          description: >-
            Primary group membership, see UserGroupLink for secondary
            memberships
          type: integer
        FullName:
          description: >-
            The associate's culture formatted fullname (firstname, middleName
            and lastname)
          type: string
        FormalName:
          description: >-
            The associate's culture formatted formalname (firstname, middleName
            and lastname, title, mrmrs)
          type: string
        Deleted:
          description: >-
            If true, the user is retired and should have no rights, not appear
            in lists, etc.
          type: boolean
        EjUserId:
          format: int32
          description: >-
            ID of the ej user record corresponding to this associate; 0 for
            associates that are not ej users
          type: integer
        UserName:
          description: User name
          type: string
        ExtraFields:
          description: "Deprecated: Use {SuperOffice.CRM.Services.Associate.CustomFields} instead.\r\nExtra fields added to the carrier. This could be data from Plug-ins, the foreign key system, external applications, etc."
          type: object
          additionalProperties:
            type: string
        CustomFields:
          description: "Udef + Extra fields added to the carrier. Extra fields as defined by changes to database schema + user-defined fields as defined by admin.\r\nCustom fields combines user defined fields and extra fields into one bucket. \r\nThe individual {SuperOffice.CRM.Services.Associate.ExtraFields} and <see cref=\"!:UserDefinedFields\">UserDefinedFields</see> properties are deprecated in favor of this\r\ncombined collection."
          type: object
          additionalProperties:
            type: string
        TableRight:
          $ref: '#/components/schemas/SuperOffice.CRM.Security.TableRight'
        FieldProperties:
          description: >-
            Field property dictionary mapping field names to field access
            rights.
          type: object
          additionalProperties:
            $ref: '#/components/schemas/SuperOffice.CRM.Security.FieldProperty'
    SuperOffice.CRM.Services.TicketCategoryEntity:
      description: "This entity describes the meta data for a ticket category, and provides special operations on it.\r\n<para />\r\nCarrier object for TicketCategoryEntity.\r\nServices for the TicketCategoryEntity Carrier is available from the <see cref=\"T:SuperOffice.CRM.Services.IListAgent\">List Agent</see>."
      type: object
      properties:
        TicketCategoryId:
          format: int32
          description: The id of the ticket category. (primary key)
          type: integer
        ParentId:
          format: int32
          description: >-
            The parent category for this category. -1 if this is a toplevel
            category.
          type: integer
        Name:
          description: The (short) name of this category. E.g. &apos;support&apos;.
          type: string
        Fullname:
          description: >-
            The fullname (compiled from parents&apos; names) for this category.
            E.g. &apos;norway/product A/support&apos;.
          type: string
        CategoryMaster:
          format: int32
          description: The user associated with this category.
          type: integer
        Flags:
          description: A bitmask representing flags for this category.
          enum:
            - Unknown
            - Internal
            - OnlyLoggedInUsers
            - DefaultToCategoryMaster
            - ListInMain
            - RedelegateNewMsg
            - DelegateToOurContact
            - PropagateReplyTemplate
            - MembersOnly
            - NotifyMembers
            - AcceptWhenReplying
          type: string
        DelegateMethod:
          description: An integer indicating the delegation method for this category.
          enum:
            - Unknown
            - Even
            - Weighted
            - Unfair
            - Not
          type: string
        ExternalName:
          description: The external name for this category, used for the customer frontend.
          type: string
        ClosingStatus:
          description: Determines the default status used in the GUI when creating a ticket
          enum:
            - UserDefined
            - Active
            - Closed
            - Postponed
          type: string
        MsgClosingStatus:
          description: >-
            Determines the default status used in the GUI when adding a request
            to a ticket
          enum:
            - UserDefined
            - Active
            - Closed
            - Postponed
          type: string
        AssignmentLag:
          format: int32
          description: >-
            Number of minutes we shall override the assignment if a customer
            sends consecutive messages to this category
          type: integer
        ReplyTemplate:
          format: int32
          description: Reply template to merge with messages posted in this category
          type: integer
        NotificationEmail:
          description: >-
            Comma separated list of addresses to notify when requests are
            redelegated to (unassigned) in this category.
          type: string
        DefaultTicketStatus:
          $ref: '#/components/schemas/SuperOffice.CRM.Services.TicketStatusEntity'
        DefaultMessageStatus:
          $ref: '#/components/schemas/SuperOffice.CRM.Services.TicketStatusEntity'
        EffectiveReplyTemplateId:
          format: int32
          description: >-
            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.
          type: integer
        ExtraFields:
          description: "Deprecated: Use {SuperOffice.CRM.Services.TicketCategoryEntity.CustomFields} instead.\r\nExtra fields added to the carrier. This could be data from Plug-ins, the foreign key system, external applications, etc."
          type: object
          additionalProperties:
            type: string
        CustomFields:
          description: "Udef + Extra fields added to the carrier. Extra fields as defined by changes to database schema + user-defined fields as defined by admin.\r\nCustom fields combines user defined fields and extra fields into one bucket. \r\nThe individual {SuperOffice.CRM.Services.TicketCategoryEntity.ExtraFields} and <see cref=\"!:UserDefinedFields\">UserDefinedFields</see> properties are deprecated in favor of this\r\ncombined collection."
          type: object
          additionalProperties:
            type: string
        TableRight:
          $ref: '#/components/schemas/SuperOffice.CRM.Security.TableRight'
        FieldProperties:
          description: >-
            Field property dictionary mapping field names to field access
            rights.
          type: object
          additionalProperties:
            $ref: '#/components/schemas/SuperOffice.CRM.Security.FieldProperty'
    SuperOffice.CRM.Services.TicketPriorityEntity:
      description: "Entity for a ticket priority. This entity describes the meta data for a ticket priority, and provides special operations on it.\r\n<para />\r\nCarrier object for TicketPriorityEntity.\r\nServices for the TicketPriorityEntity Carrier is available from the <see cref=\"T:SuperOffice.CRM.Services.IListAgent\">List Agent</see>."
      type: object
      properties:
        TicketPriorityId:
          format: int32
          description: The primary key (auto-incremented)
          type: integer
        Name:
          description: The name of the priority.
          type: string
        Status:
          description: The status (normal/deleted) of the priority.
          enum:
            - Unknown
            - Normal
            - Deleted
          type: string
        Flags:
          description: A bitmask of flags.
          enum:
            - Unknown
            - External
            - Default
            - AlertSchedule
          type: string
        SortOrder:
          format: int32
          description: Indicates the sort order for this priority. 1 is first, 100 is last
          type: integer
        TicketRead:
          description: >-
            This field indicates what to do with the escalation chain when the
            request is read
          enum:
            - None
            - Stop
            - Continue
            - Restart
          type: string
        ChangedOwner:
          description: >-
            This field indicates what to do with the escalation chain when the
            request changes owner (manually)
          enum:
            - None
            - Stop
            - Continue
            - Restart
          type: string
        TicketNewinfo:
          description: >-
            This field indicates what to do with the escalation chain when the
            request gets new info
          enum:
            - None
            - Stop
            - Continue
            - Restart
          type: string
        TicketClosed:
          description: >-
            This field indicates what to do with the escalation chain when the
            request is closed
          enum:
            - None
            - Stop
            - Continue
            - Restart
          type: string
        TicketChangedPriority:
          description: >-
            This field indicates what to do with the escalation chain when the
            request is changed into this priority
          enum:
            - None
            - Stop
            - Continue
            - Restart
          type: string
        TicketNew:
          description: >-
            This field indicates what to do with the escalation chain when a new
            request is registered
          enum:
            - None
            - Stop
            - Continue
            - Restart
          type: string
        Deadline:
          format: int32
          description: Deadline to add if escalated (minutes)
          type: integer
        MonStart:
          format: date-time
          description: >-
            The work hour start for Mondays. Note that only the time part of the
            DateTime is used
          type: string
        MonStop:
          format: date-time
          description: >-
            The work hour start for Mondays. Note that only the time part of the
            DateTime is used
          type: string
        TueStart:
          format: date-time
          description: >-
            The work hour start for Tuesdays. Note that only the time part of
            the DateTime is used
          type: string
        TueStop:
          format: date-time
          description: >-
            The work hour stop for Tuesdays. Note that only the time part of the
            DateTime is used
          type: string
        WedStart:
          format: date-time
          description: >-
            The work hour start for Wednesdays. Note that only the time part of
            the DateTime is used
          type: string
        WedStop:
          format: date-time
          description: >-
            The work hour stop for Wednesdays. Note that only the time part of
            the DateTime is used
          type: string
        ThuStart:
          format: date-time
          description: >-
            The work hour start for Thursdays. Note that only the time part of
            the DateTime is used
          type: string
        ThuStop:
          format: date-time
          description: >-
            The work hour stop for Thursdays. Note that only the time part of
            the DateTime is used
          type: string
        FriStart:
          format: date-time
          description: >-
            The work hour start for Fridays. Note that only the time part of the
            DateTime is used
          type: string
        FriStop:
          format: date-time
          description: >-
            The work hour stop for Fridays. Note that only the time part of the
            DateTime is used
          type: string
        SatStart:
          format: date-time
          description: >-
            The work hour start for Saturdays. Note that only the time part of
            the DateTime is used
          type: string
        SatStop:
          format: date-time
          description: >-
            The work hour stop for Saturdays. Note that only the time part of
            the DateTime is used
          type: string
        SunStart:
          format: date-time
          description: >-
            The work hour start for Sundays. Note that only the time part of the
            DateTime is used
          type: string
        SunStop:
          format: date-time
          description: >-
            The work hour stop for Sundays. Note that only the time part of the
            DateTime is used
          type: string
        NonDates:
          description: >-
            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
          type: array
          items:
            format: date-time
            type: string
        EscalationLevels:
          description: Escalation levels bound to the parent priority
          type: array
          items:
            $ref: >-
              #/components/schemas/SuperOffice.CRM.Services.TicketPriorityEscalationLevelEntity
        TableRight:
          $ref: '#/components/schemas/SuperOffice.CRM.Security.TableRight'
        FieldProperties:
          description: >-
            Field property dictionary mapping field names to field access
            rights.
          type: object
          additionalProperties:
            $ref: '#/components/schemas/SuperOffice.CRM.Security.FieldProperty'
    SuperOffice.CRM.Services.TicketStatusEntity:
      description: "Entity for a ticket status. This entity describes the meta data for a ticket status, and provides special operations on it.\r\n<para />\r\nCarrier object for TicketStatusEntity.\r\nServices for the TicketStatusEntity Carrier is available from the <see cref=\"T:SuperOffice.CRM.Services.IListAgent\">List Agent</see>."
      type: object
      properties:
        TicketStatusId:
          format: int32
          description: The primary key (auto-incremented)
          type: integer
        Name:
          description: Name of user defined ticket status
          type: string
        Status:
          description: >-
            The &apos;classic&apos; ticket status. I.e.
            active/closed/postponed/deleted
          enum:
            - Unknown
            - Active
            - Closed
            - Postponed
            - Deleted
            - Merged
            - Spam
            - PostponedSpecific
            - Postponed1Hour
            - Postponed2Hours
            - Postponed3Hours
            - Postponed4Hours
            - PostponedDay
            - PostponedWeek
            - PostponedMonth
          type: string
        TimeCounter:
          description: >-
            Which field in ticket we count time spent on (queue, internal,
            external)
          enum:
            - None
            - Internally
            - Externally
            - Queue
          type: string
        NoEmailReopen:
          description: Whether inbound emails can reopen requests with this status or not
          type: boolean
        IsDefault:
          description: >-
            Indicates if status is default one as there might be more than one
            status with same internal status
          type: boolean
        UsedInQueue:
          description: If set, status is used in GetNext calculations
          type: boolean
        TableRight:
          $ref: '#/components/schemas/SuperOffice.CRM.Security.TableRight'
        FieldProperties:
          description: >-
            Field property dictionary mapping field names to field access
            rights.
          type: object
          additionalProperties:
            $ref: '#/components/schemas/SuperOffice.CRM.Security.FieldProperty'
    SuperOffice.CRM.Services.Person:
      description: "Carrier object for Person.\r\nServices for the Person Carrier is available from the <see cref=\"T:SuperOffice.CRM.Services.IPersonAgent\">Person Agent</see>."
      type: object
      properties:
        Position:
          description: >-
            The position. This is a predefined SuperOffice value, different from
            Title
          type: string
        PersonId:
          format: int32
          description: Primary key
          type: integer
        Mrmrs:
          description: e.g. Mrs   sex_title
          type: string
        Firstname:
          description: First name
          type: string
        Lastname:
          description: Last name
          type: string
        MiddleName:
          description: Middle name or 'van' etc.
          type: string
        Title:
          description: Title
          type: string
        Description:
          description: Info text/description on person.
          type: string
        Email:
          description: First email on contact person.
          type: string
        FullName:
          description: >-
            Get the persons full name (internal name used in clients for
            employees).
          type: string
        DirectPhone:
          description: Returns the direct phone that belong to the contact person.
          type: string
        FormalName:
          description: >-
            Get formal name for a person, as used in labels. (Full name + person
            title + academic title)
          type: string
        CountryId:
          format: int32
          description: Country
          type: integer
        ContactId:
          format: int32
          description: Owning contact ID
          type: integer
        ContactName:
          description: The persons company name
          type: string
        Retired:
          format: int32
          description: >-
            1 = the user is retired and should have no rights, not appear in
            lists, etc.
          type: integer
        Rank:
          format: int32
          description: Display sort sequence for default sort order
          type: integer
        ActiveInterests:
          format: int32
          description: >-
            Number of records in pintr table; select count(*) from pintr pi
            where pi.person_id = this.person_id == activeInterests is always
            true
          type: integer
        ContactDepartment:
          description: The persons contact department
          type: string
        ContactCountryId:
          format: int32
          description: The persons contact country id
          type: integer
        ContactOrgNr:
          description: The persons contact organization number
          type: string
        FaxPhone:
          description: Returns the fax phone that belong to the contact person.
          type: string
        MobilePhone:
          description: Returns the mobile phone that belong to the contact person.
          type: string
        ContactPhone:
          description: Returns the direct phone that belong to the persons contact.
          type: string
        AssociateName:
          description: Name of the person's owner
          type: string
        AssociateId:
          format: int32
          description: Id of the item's owner (Associate id)
          type: integer
        UsePersonAddress:
          description: If 1, use person's address for mailing instead of company address
          type: boolean
        ContactFax:
          description: Actual phone number as eneterd by the user
          type: string
        Kanafname:
          description: Kana first name, used in Japanese versions only
          type: string
        Kanalname:
          description: Kana last name, used in Japanese versions only
          type: string
        Post1:
          description: Postal address, used in Japanese versions only
          type: string
        Post2:
          description: Postal address, used in Japanese versions only
          type: string
        Post3:
          description: Postal address, used in Japanese versions only
          type: string
        EmailName:
          description: E-mail description
          type: string
        ContactFullName:
          description: Company full name + department
          type: string
        ActiveErpLinks:
          format: int32
          description: How many active ERP links are there for this person?
          type: integer
        TicketPriorityId:
          format: int32
          description: Ticket priority ID
          type: integer
        SupportLanguageId:
          format: int32
          description: Support priority ID
          type: integer
        SupportAssociateId:
          format: int32
          description: Our support contact for this person
          type: integer
        CategoryName:
          description: The category list item name
          type: string
        PersonNumber:
          description: Alphanumeric user field
          type: string
        TableRight:
          $ref: '#/components/schemas/SuperOffice.CRM.Security.TableRight'
        FieldProperties:
          description: >-
            Field property dictionary mapping field names to field access
            rights.
          type: object
          additionalProperties:
            $ref: '#/components/schemas/SuperOffice.CRM.Security.FieldProperty'
    SuperOffice.CRM.Services.TicketMessage:
      description: "The TicketMessage carrier is used for representing a service ticket message\r\n<para />\r\nCarrier object for TicketMessage.\r\nServices for the TicketMessage Carrier is available from the <see cref=\"T:SuperOffice.CRM.Services.ITicketAgent\">Ticket Agent</see>."
      type: object
      properties:
        TicketMessageId:
          format: int32
          description: The primary key (auto-incremented)
          type: integer
        CreatedAt:
          format: date-time
          description: When the message was posted.
          type: string
        Slevel:
          description: The securitylevel of the message.
          enum:
            - Unknown
            - Internal
            - External
          type: string
        Important:
          description: If this message is important or not.
          type: boolean
        Author:
          description: >-
            A string representing the author of the message. Could be a
            user&apos;s name, or a persons email address.
          type: string
        PersonId:
          format: int32
          description: Primary key
          type: integer
        PersonFullName:
          description: >-
            Get the persons full name (internal name used in clients for
            employees).
          type: string
        ContactId:
          format: int32
          description: Primary key
          type: integer
        ContactName:
          description: Contact name
          type: string
        ContactDepartment:
          description: Department
          type: string
        NumAttachments:
          format: int32
          description: Number of attachments in the message
          type: integer
        EmailHeader:
          description: The email header is saved in this field as raw text
          type: string
        MessageHeaders:
          description: >-
            Contains the message headers, like To, Cc, Bcc information, or
            custom headers
          type: array
          items:
            $ref: '#/components/schemas/SuperOffice.CRM.Services.TicketMessageHeader'
        Language:
          description: The language this message is in, based on some kind of analysis
          type: string
        Sentiment:
          format: int32
          description: >-
            Sentiment index, 100 = completely happy; -100 = suicidally unhappy;
            0 = no idea
          type: integer
        SentimentConfidence:
          format: int32
          description: Confidence of sentiment index, 0 = no idea, 100 = completely sure
          type: integer
        CreatedBy:
          format: int32
          description: >-
            The id of the user who posted the message. The value 1 (system user)
            for externally posted messages.
          type: integer
        ChangedAt:
          format: date-time
          description: When the message was changed.
          type: string
        Badge:
          description: Badge to explicitly determine how a message was generated
          enum:
            - Unknown
            - Reply
            - Forward
            - Comment
            - Incoming
            - Outgoing
          type: string
        TableRight:
          $ref: '#/components/schemas/SuperOffice.CRM.Security.TableRight'
        FieldProperties:
          description: >-
            Field property dictionary mapping field names to field access
            rights.
          type: object
          additionalProperties:
            $ref: '#/components/schemas/SuperOffice.CRM.Security.FieldProperty'
    SuperOffice.CRM.Services.Tag:
      description: "Carrier object for Tag.\r\nServices for the Tag Carrier is available from the <see cref=\"T:SuperOffice.CRM.Services.IListAgent\">List Agent</see>."
      type: object
      properties:
        Id:
          format: int32
          description: The Id of the ListItem
          type: integer
        Name:
          description: The name of the ListItem
          type: string
        ToolTip:
          description: The tooltip of the ListItem
          type: string
        TableRight:
          $ref: '#/components/schemas/SuperOffice.CRM.Security.TableRight'
        FieldProperties:
          description: >-
            Field property dictionary mapping field names to field access
            rights.
          type: object
          additionalProperties:
            $ref: '#/components/schemas/SuperOffice.CRM.Security.FieldProperty'
    SuperOffice.CRM.Services.Sale:
      description: "Carrier object for Sale.\r\nServices for the Sale Carrier is available from the <see cref=\"T:SuperOffice.CRM.Services.ISaleAgent\">Sale Agent</see>."
      type: object
      properties:
        ContactName:
          description: Contact name
          type: string
        SaleDate:
          format: date-time
          description: (expected / lost / won) sales date
          type: string
        SaleId:
          format: int32
          description: Primary key
          type: integer
        Probability:
          format: int32
          description: Actual probability, may differ from the one in the list
          type: integer
        Title:
          description: Sale heading (short description?)
          type: string
        Amount:
          format: double
          description: Total sale amount
          type: number
        Currency:
          description: Currency the sale was made in.
          type: string
        ProjectName:
          description: Project name
          type: string
        AssociateFullName:
          description: The sale's owner
          type: string
        Description:
          description: The sales description
          type: string
        Status:
          description: The sale's status, indicating wether the sale is open, sold or lost.
          enum:
            - Unknown
            - Open
            - Sold
            - Lost
            - Stalled
            - SaintAll
          type: string
        WeightedAmount:
          format: double
          description: The weighted amount ( amount *  probability / 100)
          type: number
        ProjectId:
          format: int32
          description: Optional project reference
          type: integer
        EarningPercent:
          format: double
          description: Earning as percent of total
          type: number
        Earning:
          format: double
          description: Earning on sale
          type: number
        ContactId:
          format: int32
          description: Optional contact reference
          type: integer
        AssociateId:
          format: int32
          description: The sale's owner id
          type: integer
        PersonId:
          format: int32
          description: The sale's contact persons id
          type: integer
        SaleTypeId:
          format: int32
          description: The sale's type id
          type: integer
        SaleTypeName:
          description: The sale's type name
          type: string
        PersonFullName:
          description: The name of the person this sale belongs to.
          type: string
        Completed:
          description: >-
            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.
          enum:
            - Unknown
            - NotStarted
            - Started
            - Completed
          type: string
        ActiveErpLinks:
          format: int32
          description: The number of active erp links
          type: integer
        NextDueDate:
          format: date-time
          description: >-
            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.
          type: string
        Number:
          description: Alphanumeric user field
          type: string
        TableRight:
          $ref: '#/components/schemas/SuperOffice.CRM.Security.TableRight'
        FieldProperties:
          description: >-
            Field property dictionary mapping field names to field access
            rights.
          type: object
          additionalProperties:
            $ref: '#/components/schemas/SuperOffice.CRM.Security.FieldProperty'
    SuperOffice.CRM.Services.Project:
      description: "Carrier object for Project.\r\nServices for the Project Carrier is available from the <see cref=\"T:SuperOffice.CRM.Services.IProjectAgent\">Project Agent</see>."
      type: object
      properties:
        ProjectId:
          format: int32
          description: Primary key
          type: integer
        Name:
          description: Project name
          type: string
        Description:
          description: The projects description
          type: string
        URL:
          description: URL address
          type: string
        Type:
          description: The project type.
          type: string
        AssociateId:
          format: int32
          description: The project owner id (associate id)
          type: integer
        AssociateFullName:
          description: The project owner
          type: string
        TypeId:
          format: int32
          description: ''
          type: integer
        Updated:
          format: date-time
          description: Last updated date  in UTC.
          type: string
        StatusId:
          format: int32
          description: The projects status id
          type: integer
        Status:
          description: The projects status
          type: string
        TextId:
          format: int32
          description: The id of the description
          type: integer
        PublishTo:
          format: date-time
          description: Publication valid to (inclusive)
          type: string
        PublishFrom:
          format: date-time
          description: Publication valid from (inclusive)
          type: string
        IsPublished:
          description: ''
          type: boolean
        URLName:
          description: Visible field
          type: string
        ProjectNumber:
          description: Automatically generated number
          type: string
        ActiveErpLinks:
          format: int32
          description: The number of active erp links
          type: integer
        EventId:
          format: int32
          description: Reserved field for Lyyti event when project is linked to an event.
          type: integer
        StartDate:
          format: date-time
          description: >-
            Reserved field for Lyyti event when project is linked to an event,
            is the event start date.
          type: string
        TableRight:
          $ref: '#/components/schemas/SuperOffice.CRM.Security.TableRight'
        FieldProperties:
          description: >-
            Field property dictionary mapping field names to field access
            rights.
          type: object
          additionalProperties:
            $ref: '#/components/schemas/SuperOffice.CRM.Security.FieldProperty'
    SuperOffice.CRM.Services.TicketFormSubmission:
      description: "Class representing form submission related to ticket.\r\n<para />\r\nCarrier object for TicketFormSubmission."
      type: object
      properties:
        FormSubmissionId:
          format: int32
          description: Primary key
          type: integer
        EmailAddress:
          description: The email address of the person who submitted
          type: string
        Status:
          description: What is the status of this submission
          enum:
            - Unknown
            - InProgress
            - EmailVerification
            - Submitted
            - Processed
            - Failed
          type: string
    SuperOffice.CRM.Services.TicketType:
      description: "Ticket Type - light read-only version of TicketTypeEntity.\r\n<para />\r\nCarrier object for TicketType.\r\nServices for the TicketType Carrier is available from the <see cref=\"T:SuperOffice.CRM.Services.IListAgent\">List Agent</see>."
      type: object
      properties:
        TicketTypeId:
          format: int32
          description: Primary key
          type: integer
        Name:
          description: The list item
          type: string
        Icon:
          description: Name of the icon
          type: string
        DefaultTicketStatus:
          format: int32
          description: Default ticket status for new tickets
          type: integer
        DefaultTicketPriority:
          format: int32
          description: Default ticket priority for new tickets
          type: integer
        IsDefault:
          description: Is this Ticket Type marked as default
          type: boolean
        ShowInNew:
          description: Enables this request type to be accessible in +New in top bar
          type: boolean
        ExcludeSignature:
          description: Do not insert user signature automatically
          type: boolean
        ExcludeEmailRecipients:
          description: Create request without initially having to send outbound e-mail
          type: boolean
        ExternalAsDefault:
          description: Ability to set external access level for this request type
          type: boolean
        VisibleForGroups:
          description: Array of references to the visible for groups
          type: array
          items:
            format: int32
            type: integer
        ReplyForwardNoSignature:
          description: Do not insert user signature when replying or forwarding the message
          type: boolean
        ReplyExternalAsDefault:
          description: Set external access level when replying the message
          type: boolean
        TableRight:
          $ref: '#/components/schemas/SuperOffice.CRM.Security.TableRight'
        FieldProperties:
          description: >-
            Field property dictionary mapping field names to field access
            rights.
          type: object
          additionalProperties:
            $ref: '#/components/schemas/SuperOffice.CRM.Security.FieldProperty'
    SuperOffice.CRM.Security.TableRight:
      description: "Wraps a table right together with an explanatory reason.\r\nCode can indicate why access is restricted."
      type: object
      properties:
        Mask:
          type: string
        Reason:
          type: string
    SuperOffice.CRM.Security.FieldProperty:
      description: >-
        Class holding properties like field length, field type about a field in
        the carrier.
      type: object
      properties:
        FieldRight:
          $ref: '#/components/schemas/SuperOffice.CRM.Security.FieldRight'
        FieldType:
          type: string
        FieldLength:
          format: int32
          description: ''
          type: integer
    SuperOffice.CRM.Services.TicketPriorityEscalationLevelEntity:
      description: "Entity for ticket priority escalation level. Entity describes properties/actions when escalation(alert) happens. Alert is raised according to TicketPriority timing intervals\r\n<para />\r\nCarrier object for TicketPriorityEscalationLevelEntity.\r\nServices for the TicketPriorityEscalationLevelEntity Carrier is available from the <see cref=\"T:SuperOffice.CRM.Services.IListAgent\">List Agent</see>."
      type: object
      properties:
        TicketAlertId:
          format: int32
          description: The primary key (auto-incremented)
          type: integer
        AlertLevel:
          format: int32
          description: The alert level (strictly ascending number).
          type: integer
        AlertTimeout:
          format: int32
          description: The time (in minutes) before ticket is escalated to next level.
          type: integer
        Action:
          format: int32
          description: >-
            Bitmap indicating what should be done when escalating *to* this
            level.
          type: integer
        DelegateTo:
          format: int32
          description: >-
            If ticket should be redelegated on escalation, this field contains
            the id of the target user.
          type: integer
        ScriptId:
          format: int32
          description: Script that can be executed then the ticket alert action occur.
          type: integer
        EmailTo:
          description: >-
            If an email should be sent when escalating, this field will contain
            the recipient email address.
          type: string
        SmsTo:
          description: >-
            If an sms should be sent when escalating, this field will contain
            the recipient email address.
          type: string
        ReplyTemplateIdCustomer:
          format: int32
          description: >-
            Reference to the reply template used in this alert, for mail to
            customer
          type: integer
        ReplyTemplateIdUser:
          format: int32
          description: >-
            Reference to the reply template used in this alert, for mail to
            owner of ticket
          type: integer
        ReplyTemplateIdCatmast:
          format: int32
          description: >-
            Reference to the reply template used in this alert, for mail to
            category master
          type: integer
        ReplyTemplateIdEmail:
          format: int32
          description: >-
            Reference to the reply template used in this alert, for mail to
            custom address
          type: integer
        RtiCustomerSms:
          format: int32
          description: >-
            Reference to the reply template used in this alert, for sms to
            customer
          type: integer
        ReplyTemplateIdUserSms:
          format: int32
          description: >-
            Reference to the reply template used in this alert, for sms to owner
            of ticket
          type: integer
        ReplyTemplateIdCatmastSms:
          format: int32
          description: >-
            Reference to the reply template used in this alert, for sms to
            category master
          type: integer
        ReplyTemplateIdSms:
          format: int32
          description: >-
            Reference to the reply template used in this alert, for sms to
            custom address
          type: integer
        TableRight:
          $ref: '#/components/schemas/SuperOffice.CRM.Security.TableRight'
        FieldProperties:
          description: >-
            Field property dictionary mapping field names to field access
            rights.
          type: object
          additionalProperties:
            $ref: '#/components/schemas/SuperOffice.CRM.Security.FieldProperty'
    SuperOffice.CRM.Services.TicketMessageHeader:
      description: "Contains information about a header connected to a ticket message\r\n<para />\r\nCarrier object for TicketMessageHeader."
      type: object
      properties:
        Id:
          format: int32
          description: Id
          type: integer
        Name:
          description: >-
            The name of the header. This can for example be To, Cc or other
            custom headers that is set up in Service
          type: string
        Value:
          description: >-
            The value of the header. Can for example be an email address, or a
            custom header extracted from emails
          type: string
        StdItem:
          description: >-
            If this has a value, it indicates that a standard header text from
            the language database should be used - and witch one to use
          enum:
            - None
            - Forward
            - UnnamedAttachmentBlocked
            - NoAutoReply
            - SentAutoReplyToCustomersA
            - SentAutoReplyToCustomersB
            - CustomerReadFAQ
            - ReplyTemplate
          type: string
        StdItemCol:
          description: >-
            If this is 1, concatenate the standard item text with header name
            field, if 2 use header value field instead. If this col is 0, use
            the empty field - preferably the value column.
          enum:
            - None
            - Name
            - Value
          type: string
        TableRight:
          $ref: '#/components/schemas/SuperOffice.CRM.Security.TableRight'
        FieldProperties:
          description: >-
            Field property dictionary mapping field names to field access
            rights.
          type: object
          additionalProperties:
            $ref: '#/components/schemas/SuperOffice.CRM.Security.FieldProperty'
    SuperOffice.CRM.Security.FieldRight:
      description: "Wraps the field right together with an explanatory reason.\r\nAlso adds logical operators to the field rights so that they can be easily combined."
      type: object
      properties:
        Mask:
          type: string
        Reason:
          type: string

````

## Related topics

- [Merge Tickets](/en/api/reference/restful/agent/ticket_agent/merge-tickets.md)
- [SuperOffice.WebApi.Data.Ticket MergeTicketsRequest](/en/api/reference/webapi/SuperOffice.WebApi.Data.Ticket_MergeTicketsRequest.md)
- [SuperOffice.WebApi.Agents.TicketAgent](/en/api/reference/webapi/SuperOffice.WebApi.Agents.TicketAgent.md)
- [SuperOffice.WebApi.Agents.ITicketAgent](/en/api/reference/webapi/SuperOffice.WebApi.Agents.ITicketAgent.md)
- [Split and merge](/en/automation/crmscript/howto/request/split-merge.md)
- [Merge](/en/api/reference/restful/rest/contact/merge.md)
