POST api/Categories/CreateCategory

Creates a category. Only Administrator can do that.

Request Information

URI Parameters

None.

Body Parameters

Name	Description	Type	Additional information
Name	(Required) Name. Max length 256.	string	None.
Disabled	The category will be disabled.	boolean	None.
SelectionRequired	The category must be selected.	boolean	None.
DisableForNewEntity	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.
ForChats	Enable the category for chats.	boolean	None.
ShowForUserInTickets	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 "ShowForUserInTickets" must be true otherwise the property will be ignored.	boolean	None.
UserCanEditInTickets	End user and smart user can edit the category inside tickets. The "ShowForUserInTickets" 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:

{
  "Name": "New category",
  "Disabled": false,
  "SelectionRequired": true,
  "DisableForNewEntity": false,
  "ForTickets": true,
  "ForCalls": false,
  "ForChats": false,
  "ShowForUserInTickets": true,
  "UserCanInsertInTickets": false,
  "UserCanEditInTickets": false,
  "SelectedServiceIds": null,
  "SelectedChatProfileIds": null
}

application/xml, text/xml

Sample:

<CreateCategoryPost xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/RequestorApiDataStructures.Posts">
  <DisableForNewEntity>false</DisableForNewEntity>
  <Disabled>false</Disabled>
  <ForCalls>false</ForCalls>
  <ForChats>false</ForChats>
  <ForTickets>true</ForTickets>
  <Name>New 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>true</SelectionRequired>
  <ShowForUserInTickets>true</ShowForUserInTickets>
  <UserCanEditInTickets>false</UserCanEditInTickets>
  <UserCanInsertInTickets>false</UserCanInsertInTickets>
</CreateCategoryPost>

Response Information

Resource Description

Returns id

IHttpActionResult

None.