Back to SuperOfficeUpdate a ChatSessionEntity with changes, as described in a JSON Patch or a JSON Merge Patch document.
See RFC6902 and RFC 7396. Update the Department field to "foo" can be done either as a JSON PATCH:
[ { "op": "replace", "path": "/Department", "value": "foo" } ]
or as a JSON MERGE PATCH, which describes the change directly:
{ "Department": "foo" }
JSON PATCH supports operations 'add', 'replace', 'remove' and 'test'.
The path is case insensitive, and the leading slash is optional, so the paths "/department", "Department" and "department" are all equivalent.
Calls the {SuperOffice.CRM.Services.IChatAgent} service SaveChatSessionEntity.
Input
type: object
properties:
parameters:
type: object
properties:
id:
type: string
description: The ChatSessionEntity id to update.
$select:
type: string
description: >-
Optional comma separated list of properties to include in the result.
Other fields are then nulled out to reduce payload size:
"Name,department,category" Default = show all fields.
Accept-Language:
type: string
description: >-
Convert string references and multi-language values into a specified
language (iso2) code.
SO-Language:
type: string
description: >-
Convert string references and multi-language values into a specified
language (iso2) code. Overrides Accept-Language value.
SO-Culture:
type: string
description: >-
Number, date formatting in a specified culture (iso2 language) code.
Partially overrides SO-Language/Accept-Language value. Ignored if no
Language set.
SO-TimeZone:
type: string
description: >-
Specify the timezone code that you would like date/time responses
converted to.
SO-AppToken:
type: string
description: >-
The application token that identifies the partner app. Used when
calling Online WebAPI from a server.
changes:
description: "\r\n\r\nCan also be a JSON-MERGE-PATCH object, like this\r\n\r\n```json\r\n { 'Name': 'New Name' }\r\n\r\n```\r\n"
type: array
items:
description: >-
Describes Json-Patch changes in the form
https://tools.ietf.org/html/rfc6902
type: object
properties:
op:
description: "\"add\", \"replace\", \"remove\", \"test\"\r\n\"move\" and \"copy\" not supported"
enum:
- unknown
- add
- replace
- remove
- test
- move
- copy
type: string
path:
description: "The property names to modify. \r\n\"/users/0/email\", \"/users/-\","
type: string
value:
description: New/Replaced value - string or object.
type: object
example:
- op: 1
path: /Name
value: New Name
required:
- id
- changes
title: Parameters