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

POST Agents/List/PerformNeededCategoryUpdate

Some tooltip text!
• 2 minutes to read
 • 2 minutes to read
POST /api/v1/Agents/List/PerformNeededCategoryUpdate

Does the actual update of the category.

Ask the user first, if user confirmed yes, do automatically update category, this call will do that actual update NsApiSlow threshold: 5000 ms.

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/List/PerformNeededCategoryUpdate?$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

PersonId, ContactId, CategoryId, Setting

Property Name Type Description
PersonId Integer
ContactId Integer
CategoryId Integer
Setting AutomatedCategoryUpdate Carrier for an automated category update setting. Carrier object for AutomatedCategoryUpdate. Services for the AutomatedCategoryUpdate Carrier is available from the List Agent.

Response:

No Content

Response Description
204 No Content

Response body: TimeZoneData

Sample request

[!include[sample request](../../samples/agent/request/v1ListAgent_PerformNeededCategoryUpdate.md)]

Sample response

[!include[sample response](../../samples/agent/response/v1ListAgent_PerformNeededCategoryUpdate.md)]
© SuperOffice. All rights reserved.
SuperOffice |  Community |  Release Notes |  Privacy |  Site feedback |  Search Docs |  About Docs |  Contribute |  Back to top