• Share
    • Twitter
    • LinkedIn
    • Facebook
    • Email
  • Feedback
  • Edit
Show / Hide Table of Contents

POST Agents/Preference/SavePreferenceEntities

Some tooltip text!
• 2 minutes to read
 • 2 minutes to read
POST /api/v1/Agents/Preference/SavePreferenceEntities

Save this set of preferences.

Query String Parameters

Parameter Name Type Description
$select string Optional comma separated list of properties to include in the result. Other fields are then nulled out to reduce payload size: "Name,department,category". Default = show all fields.
POST /api/v1/Agents/Preference/SavePreferenceEntities?$select=name,department,category/id

Request Headers

Parameter Name Description
Authorization Supports 'Basic', 'SoTicket' and 'Bearer' schemes, depending on installation type.
X-XSRF-TOKEN If not using Authorization header, you must provide XSRF value from cookie or hidden input field
Content-Type Content-type of the request body: application/json, text/json, application/xml, text/xml, application/x-www-form-urlencoded, application/json-patch+json, application/merge-patch+json
Accept Content-type(s) you would like the response in:
SO-AppToken The application token that identifies the partner app. Used when calling Online WebAPI from a server.

Request Body: request

Preferences, RemoveLowerLevels

Property Name Type Description
Preferences Array
RemoveLowerLevels Boolean

Response:

No Content

Response Description
204 No Content

Response body: TimeZoneData

Sample request

POST /api/v1/Agents/Preference/SavePreferenceEntities
Authorization: Basic dGplMDpUamUw
Accept: application/json; charset=utf-8
Accept-Language: en
Content-Type: application/json; charset=utf-8

{
  "Preferences": [
    {
      "Level": "Database",
      "RawValue": "animi",
      "Specification": null,
      "DisplayValue": "vero",
      "DisplayTooltip": "quia",
      "DisplayType": "Bool",
      "TabOrder": null,
      "TargetId": 364,
      "PrefDescId": 293,
      "TableName": "Altenwerth, Dare and McLaughlin",
      "UserPreferenceId": 940
    }
  ],
  "RemoveLowerLevels": false
}

Sample response

HTTP/1.1 204 No Content
Content-Type: application/json; charset=utf-8

null
© SuperOffice. All rights reserved.
SuperOffice |  Community |  Release Notes |  Privacy |  Site feedback |  Search Docs |  About Docs |  Contribute |  Back to top