Categories
Create, update, delete, and query Categories in Zendesk.
Table Specific Information
Select
The following queries are processed server side while other filters are processed client side within the 本製品.SELECT * FROM Categories SELECT * FROM Categories WHERE Id = '13625378761117' SELECT * FROM Categories WHERE Locale = 'en-us' SELECT * FROM Categories WHERE Locale = 'en-us' AND Id = '13625378761117'
You can turn off the client-side execution of the query by setting SupportEnhancedSQL to false in which case any other search criteria will be ignored and an unfiltered response will be returned.
Insert
The Name field is required to insert. Allowed for Help Center managers.
INSERT INTO Categories (Name, Locale) VALUES ('Test CData', 'en-us')
Update
You must specify the Id of the Category to update. It only update the category-level metadata such as Position, etc. It does not update category translation properties such as Name, Description, etc. All fields that are not readonly (readonly="false" in the table) are optional. Allowed for Help Center managers.
UPDATE Categories SET Position = 2 WHERE Id = '13626563785373'
Delete
You must specify the Id of the Category to delete it. Allowed for Help Center managers.
DELETE FROM Categories WHERE Id = '13626686793885' DELETE FROM Categories WHERE Id = '13626686793885' AND Locale = 'en-us'
Columns
Name | Type | ReadOnly | References | Description |
Id [KEY] | Long | True |
Automatically assigned when creating categories. | |
Name | String | False |
The name of the category. | |
Description | String | False |
The description of the category. | |
Locale | String | False |
The locale where the category is displayed. | |
CreatedAt | Datetime | True |
The time at which the category was created. | |
UpdatedAt | Datetime | True |
The time at which the category was last updated. | |
Url | String | True |
The API url of this category. | |
HtmlUrl | String | True |
The url of this category in Help Center. | |
Outdated | Boolean | True |
Whether the category is out of date. | |
Position | Integer | False |
The position of this category relative to other categories. | |
SourceLocale | String | True |
The source (default) locale of the category. |