POST api/Categories/UpdateCategory

Updates the category. Only Administrator can do that.

Request Information

URI Parameters

None.

Body Parameters

UpdateCategoryPost
NameDescriptionTypeAdditional information
Id

Category Id

integer

None.

Name

(Required) Name. Max length 256. At least one name for one language must be set.

string

None.

Disabled

The category will be disabled.

boolean

None.

DisableForNewEntity

OBSOLETE, USE ForTicketsRequired INSTEAD

boolean

None.

DisableForNewTicket

Disable the category inside a new ticket.

boolean

None.

ForTickets

Enable the category for tickets.

boolean

None.

ForCalls

Enable the category for calls.

boolean

None.

ForCompanies

Enable the category for companies.

boolean

None.

ForUsers

Enable the category for users.

boolean

None.

ForChats

Enable the category for chats.

boolean

None.

ForTrackTimeRecords

Enable the category for track time records.

boolean

None.

SelectionRequired

OBSOLETE, USE ForTicketsRequired INSTEAD

boolean

None.

ForTicketsRequired

The category must be selected for Tickets.

boolean

None.

ForCompaniesRequired

The category must be selected for Companies.

boolean

None.

ForUsersRequired

The category must be selected for Users.

boolean

None.

ForTrackTimeRecordsRequired

The category must be selected for TrackTimeRecords.

boolean

None.

ForChatsRequired

The category must be selected for Chats.

boolean

None.

ForCallsRequired

The category must be selected for Calls.

boolean

None.

ForTicketsRequiredWhenFinished

The category must be selected when the ticket is being finished.

boolean

None.

ShowForEndUserAndSmartUser

End user and smart user can see the category inside tickets.

boolean

None.

UserCanInsertInTickets

End user and smart user can insert the category inside the creating ticket. The "ShowForEndUserAndSmartUser" must be true otherwise the property will be ignored.

boolean

None.

EndUserAndSmartUserCanEdit

End user and smart user can edit the category inside tickets. The "ShowForEndUserAndSmartUser" must be true otherwise the property will be ignored.

boolean

None.

SelectedServiceIds

The services when the category will be shown. If you let the property empty the category will be shown on all services.

Collection of integer

None.

SelectedChatProfileIds

The chat profiles when the category will be shown. If you let the property empty the category will be shown on all chat profiles.

Collection of integer

None.

Request Formats

application/json, text/json

Sample:
{
  "Id": 1,
  "Name": "Category",
  "Disabled": false,
  "DisableForNewEntity": false,
  "DisableForNewTicket": false,
  "ForTickets": true,
  "ForCalls": false,
  "ForCompanies": false,
  "ForUsers": false,
  "ForChats": false,
  "ForTrackTimeRecords": false,
  "SelectionRequired": false,
  "ForTicketsRequired": true,
  "ForCompaniesRequired": false,
  "ForUsersRequired": false,
  "ForTrackTimeRecordsRequired": false,
  "ForChatsRequired": false,
  "ForCallsRequired": false,
  "ForTicketsRequiredWhenFinished": false,
  "ShowForEndUserAndSmartUser": true,
  "UserCanInsertInTickets": false,
  "EndUserAndSmartUserCanEdit": false,
  "SelectedServiceIds": null,
  "SelectedChatProfileIds": null
}

application/xml, text/xml

Sample:
<UpdateCategoryPost xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/RequestorApiDataStructures.Posts">
  <DisableForNewEntity>false</DisableForNewEntity>
  <DisableForNewTicket>false</DisableForNewTicket>
  <Disabled>false</Disabled>
  <EndUserAndSmartUserCanEdit>false</EndUserAndSmartUserCanEdit>
  <ForCalls>false</ForCalls>
  <ForCallsRequired>false</ForCallsRequired>
  <ForChats>false</ForChats>
  <ForChatsRequired>false</ForChatsRequired>
  <ForCompanies>false</ForCompanies>
  <ForCompaniesRequired>false</ForCompaniesRequired>
  <ForTickets>true</ForTickets>
  <ForTicketsRequired>true</ForTicketsRequired>
  <ForTicketsRequiredWhenFinished>false</ForTicketsRequiredWhenFinished>
  <ForTrackTimeRecords>false</ForTrackTimeRecords>
  <ForTrackTimeRecordsRequired>false</ForTrackTimeRecordsRequired>
  <ForUsers>false</ForUsers>
  <ForUsersRequired>false</ForUsersRequired>
  <Name>Category</Name>
  <SelectedChatProfileIds xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays" i:nil="true" />
  <SelectedServiceIds xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays" i:nil="true" />
  <SelectionRequired>false</SelectionRequired>
  <ShowForEndUserAndSmartUser>true</ShowForEndUserAndSmartUser>
  <UserCanInsertInTickets>false</UserCanInsertInTickets>
  <Id>1</Id>
</UpdateCategoryPost>

Response Information

Resource Description

integer

Response Formats

application/json, text/json

Sample:
1

application/xml, text/xml

Sample:
<int xmlns="http://schemas.microsoft.com/2003/10/Serialization/">1</int>