> ## 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. # Transfer Chat Session > Request to send the session to another user. If the session does not belong to the user, nothing happens. ## OpenAPI ````yaml /openapi/rest/openapi-v3-ChatSession.json post /api/v1/ChatSession/{chatSessionId}/TransferTo/{toAssociate} openapi: 3.0.0 info: version: v1-REST title: SuperOffice REST API v1 description: SuperOffice REST API - ChatSession 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/ChatSession/{chatSessionId}/TransferTo/{toAssociate}: post: tags: - ChatSession summary: Transfer Chat Session description: |- Request to send the session to another user. If the session does not belong to the user, nothing happens. operationId: v1ChatSessionEntity_TransferChatSession parameters: - name: chatSessionId in: path description: id of the chat session to send required: true schema: type: integer format: int32 - name: toAssociate in: path description: Associate username or associate id to send session to. required: true schema: type: string - 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.ChatSessionEntity text/json: schema: $ref: >- #/components/schemas/SuperOffice.CRM.Services.ChatSessionEntity application/xml: schema: $ref: >- #/components/schemas/SuperOffice.CRM.Services.ChatSessionEntity text/xml: schema: $ref: >- #/components/schemas/SuperOffice.CRM.Services.ChatSessionEntity application/json-patch+json: schema: $ref: >- #/components/schemas/SuperOffice.CRM.Services.ChatSessionEntity application/merge-patch+json: schema: $ref: >- #/components/schemas/SuperOffice.CRM.Services.ChatSessionEntity security: - SuperOffice_Password: [] SuperId_Authentication: [] components: schemas: SuperOffice.CRM.Services.ChatSessionEntity: description: "Chat sessions belong to a chat topic, and contain messages to/from users\r\n\r\nCarrier object for ChatSessionEntity.\r\nServices for the ChatSessionEntity Carrier is available from the Chat Agent." type: object properties: ChatSessionId: format: int32 description: The primary key (auto-incremented) type: integer TopicId: format: int32 description: The reference to the associated chat topic. type: integer User: $ref: '#/components/schemas/SuperOffice.CRM.Services.Associate' Person: $ref: '#/components/schemas/SuperOffice.CRM.Services.Person' CustomerAlias: description: The alias for the customer. type: string CustomerHost: description: The hostname or IP address for the customer. type: string CustomerName: description: The name of customer, if provided type: string CustomerEmail: description: The email address of the customer, if provided type: string CustomerPhone: description: The phone number of the customer, if provided type: string CustomerConsented: description: The customer consented when starting the session type: boolean CustomerCompanyName: description: The name of the customers company, if provided type: string Status: description: >- Enum indicating the status for the session (pending, active, closed, etc). enum: - Invalid - PreChatForm - Faq - OfflineForm - InQueue - CustomerLast - UserLast - Finished - Deleted - Closed - RequestPosted - ClosedFromQueue type: string FirstMessage: description: A copy of the first message in the chat session type: string LastMessage: description: A copy of the last message in the chat session type: string WhenRequested: format: date-time description: When the session was requested by the customer. type: string WhenStarted: format: date-time description: When the session was accepted by a user. type: string WhenEnded: format: date-time description: When the session was ended. type: string WhenIdle: format: date-time description: The last time anyone sent a message for this session. type: string WhenFetched: format: date-time description: >- The last time the customer's client refetched the data. Used to detect 'dead' session. type: string SessionKey: description: Key used to authenticate the session. type: string InitialQueuePos: format: int32 description: >- The initial queue pos (i.e. the number of pending sessions + 1) when the session was requested. type: integer AlertLevel: format: int32 description: The alert level for this chat session. type: integer Rank: format: int32 description: >- Lowest possible unique number for active sessions for user. User for color index. Starting at 1. type: integer Flags: description: Various flags for the chat session enum: - CustomerIsTyping - UserIsTyping type: string Contact: $ref: '#/components/schemas/SuperOffice.CRM.Services.Contact' Project: $ref: '#/components/schemas/SuperOffice.CRM.Services.Project' Sale: $ref: '#/components/schemas/SuperOffice.CRM.Services.Sale' Ticket: $ref: '#/components/schemas/SuperOffice.CRM.Services.Ticket' TransferTo: $ref: '#/components/schemas/SuperOffice.CRM.Services.Associate' ChatbotIsActive: description: >- Indicates that a chatbot is active on the session. This will cause bot triggers to fire. Set to 0 when bot hands off to user. type: boolean Rating: format: int32 description: Rating of this chat conversation given by the customer 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.Associate: description: "Carrier object for Associate.\r\nServices for the Associate Carrier is available from the Associate Agent." 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\nUse MDO List name \"person\" to get list items." 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 UserDefinedFields 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.Person: description: "Carrier object for Person.\r\nServices for the Person Carrier is available from the Person Agent." 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.Contact: description: "Carrier object for Contact.\r\nServices for the Contact Carrier is available from the Contact Agent." type: object properties: ContactId: format: int32 description: Primary key type: integer Name: description: Contact name type: string OrgNr: description: VAT number or similar type: string Department: description: Department type: string URL: description: The internet address to this contact type: string City: description: City corresponding to zip code type: string DirectPhone: description: The contacts phone type: string AssociateId: format: int32 description: Our contact type: integer CountryId: format: int32 description: Country type: integer EmailAddress: description: The contact email address type: string Kananame: description: Contact kana name, used in Japanese versions only type: string EmailAddressName: description: Visible field type: string URLName: description: Visible field type: string AssociateFullName: description: >- The associate's culture formatted fullname (firstname, middleName and lastname) type: string BusinessName: description: The business list item name type: string CategoryName: description: The category list item name type: string CountryName: description: Name of country in installed language type: string Address: $ref: '#/components/schemas/SuperOffice.CRM.Services.Address' FormattedAddress: description: >- The contact's address, formatted with linebreaks and spaces into a single string. type: string FullName: description: '' type: string IsOwnerContact: description: >- Is the contact an owner contact. This means that all persons on this contact can on only be internal users and not external users. type: boolean ActiveErpLinks: format: int32 description: The number of active erp links type: integer Number1: description: Alphanumeric user field type: string Number2: 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 Project Agent." 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.Sale: description: "Carrier object for Sale.\r\nServices for the Sale Carrier is available from the Sale Agent." 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.Ticket: description: "The ticket carrier is used for representing a service request.\r\n\r\nCarrier object for Ticket.\r\nServices for the Ticket Carrier is available from the Ticket Agent." 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 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: format: int32 description: >- The id of the user who created the ticket. 1 (system user) if the ticket was created externally type: integer CreatedByName: description: Initials, also login name, possibly database user name type: string Author: description: >- A string representing the author of the ticket (same as author of first message). type: string OwnedBy: format: int32 description: >- The id of the user who owns the ticket. 1 (system user) if the ticket is unassigned. type: integer OwnedByName: description: Initials, also login name, possibly database user name type: string Category: format: int32 description: The id of the category a ticket is in. type: integer CategoryName: description: The (short) name of this category. E.g. 'support'. type: string CategoryFullname: description: >- The fullname (compiled from parents' names) for this category. E.g. 'norway/product A/support'. type: string Slevel: description: The securitylevel of the ticket. enum: - Unknown - Internal - External type: string Priority: format: int32 description: The reference to the ticket_priority table. type: integer PriorityName: description: The name of the priority. type: string BaseStatus: description: The status of the ticket. I.e. active/closed/postponed/deleted enum: - Unknown - Active - Closed - Postponed - Deleted - Merged - Spam - PostponedSpecific - Postponed1Hour - Postponed2Hours - Postponed3Hours - Postponed4Hours - PostponedDay - PostponedWeek - PostponedMonth type: string TicketStatus: format: int32 description: User defined ticket status type: integer TicketStatusDisplayValue: description: Get the display name of the ticket status. type: string 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 CustId: format: int32 description: >- The reference to the customer. NULL or -1 if ticket is not connected to customer. type: integer PersonFirstname: description: First name type: string PersonMiddleName: description: Middle name or 'van' etc. type: string PersonLastname: description: Last name type: string PersonFullname: description: Get the full name for the primary person (customer) type: string 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 'master' 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'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'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'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 ContactId: format: int32 description: >- The company of the person in the cust_id field, if that person belongs to a company type: integer ContactName: description: The name of the connected contact type: string OwnedByAssociateId: format: int32 description: The associate id of the owner of the ticket. type: integer 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 SaleId: format: int32 description: Reference to sale table type: integer ProjectId: format: int32 description: Reference to project table type: integer SaleHeading: description: The heading of the connected sale type: string ProjectName: description: The name of the connected project type: string FormSubmissionId: format: int32 description: >- If this ticket was created from a form submission, this field will point to that record type: integer TicketTypeId: format: int32 description: The id of the Request Type type: integer TicketTypeName: description: The name of the Request Type 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.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.Address: description: "Street and/or Postal address, in both formatted and structured forms. You only need to modify one of the two for the change to be registered.\r\n\r\nCarrier object for Address." type: object properties: Wgs84Latitude: format: double description: >- Latitude (that's north/south), decimal degrees, relative to WGS 84 ellipsoid. SuperOffice ASA is at 59.91892. This value needs no further grid reference or other qualifying information. type: number Wgs84Longitude: format: double description: >- Longitude (that's East/west), decimal degrees, relative to WGS 84 ellipsoid. SuperOffice ASA is at 10.73159. This value needs no further grid reference or other qualifying information. type: number LocalizedAddress: description: >- LocalizedFieldArray is a list of LocalizedFieldList objects. Used to store localized information such as formatted address data. type: array items: type: array items: $ref: '#/components/schemas/SuperOffice.CRM.Services.LocalizedField' Street: $ref: '#/components/schemas/SuperOffice.CRM.Services.StructuredAddress' Postal: $ref: '#/components/schemas/SuperOffice.CRM.Services.StructuredAddress' Formatted: description: >- Read-only formatted address multi-line string. Combines street and postal into one string. e.g.: "Postboks 123,\nBrugata 123,\n1234 OSLO\n" or "Postbox 123,\nBridgelane 123,\nWest Tooting,\nEast Shire ES2 W31\n". 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 SuperOffice.CRM.Services.LocalizedField: description: "LocalizedField is used to store localized information such as formatted address data, a formatted phone number, etc.\r\n\r\nCarrier object for LocalizedField." type: object properties: Name: description: Name of the value field type: string Value: description: The field's value type: string Tooltip: description: The tooltip type: string Label: description: The label of the field type: string ValueLength: format: int32 description: Database length of the value type: integer AddressType: description: '' 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.StructuredAddress: description: "Address with structured fields (Address1, City, Zip) - does not vary its layout by country, unliked the formatted address.\r\n\r\nCarrier object for StructuredAddress." type: object properties: AtypeIdx: description: >- Bit mask, combines address type (EAddressType) and owner type (EOwnerType) enum: - Unknown - ContactPostalAddress - ContactStreetAddress - PersonPrivateAddress - QuoteBillingAddress - QuoteShippingAddress type: string Address1: description: Address line 1 type: string Address2: description: Address line 2 type: string Address3: description: Address line 3 type: string City: description: City corresponding to zip code type: string County: description: County (not country) type: string State: description: State type: string Zipcode: description: Zip code, alphanumeric type: string Formatted: description: >- Read-only formatted address multi-line string. e.g.: "Brugata 123,\n1234 OSLO\n" or "Bridgelane 123,\nWest Tooting,\nThe Shire ES2 W31\n". type: string ```` ## Related topics - [Transfer Chat Session](/en/api/reference/restful/agent/chat_agent/transfer-chat-session.md) - [SuperOffice.WebApi.Data.Chat TransferChatSessionRequest](/en/api/reference/webapi/SuperOffice.WebApi.Data.Chat_TransferChatSessionRequest.md) - [NSChatAgent](/en/automation/crmscript/reference/CRMScript.NetServer.NSChatAgent.md) - [SuperOffice.WebApi.Agents.ChatAgent](/en/api/reference/webapi/SuperOffice.WebApi.Agents.ChatAgent.md) - [SuperOffice.WebApi.Agents.IChatAgent](/en/api/reference/webapi/SuperOffice.WebApi.Agents.IChatAgent.md) - [Accept Chat Session Transfer](/en/api/reference/restful/rest/chatsession/accept-chat-session-transfer.md)