Update an entry of a value list; setting a unique flag such as default moves it here (desk:admin)
PUT /api/desk/v1/enums/{kind}/{key}
Module: Desk · operationId: updateEnumValue · Tag: Configuration · Auth: access token (Authorization: Bearer <accessToken>)
Parameters
| Name | In | Type | Required | Description |
|---|---|---|---|---|
kind |
path | string | yes | (one of linkType, source, assigneeRole, callbackStatus, callbackReason) |
key |
path | string | yes |
Request body
application/json (required)
key(string, required): Key of the entry, unique in its listlabel(string, required): Display labelarchived(boolean): Archived: kept for existing data, no longer offeredcolor(string): Display colordescription(string): Description of the entryflags(array of string): Flags of the entry (e.g. default)props(object): linkType: inverseLabelsortOrder(integer): Position in lists (ascending)system(boolean, read-only): Built-in entry desk relies on
Example:
{
"archived": false,
"description": "Dieses Ticket wurde durch das verknüpfte verursacht",
"flags": [],
"key": "caused_by",
"label": "Verursacht durch",
"props": {
"inverse": "Verursacht"
},
"sortOrder": 4,
"system": true
}
Responses
- 200 Saved (
application/json)
Fields of the 200 answer:
key(string, required): Key of the entry, unique in its listlabel(string, required): Display labelarchived(boolean): Archived: kept for existing data, no longer offeredcolor(string): Display colordescription(string): Description of the entryflags(array of string): Flags of the entry (e.g. default)props(object): linkType: inverseLabelsortOrder(integer): Position in lists (ascending)system(boolean, read-only): Built-in entry desk relies on
Example 200 answer:
{
"archived": false,
"description": "Dieses Ticket wurde durch das verknüpfte verursacht",
"flags": [],
"key": "caused_by",
"label": "Verursacht durch",
"props": {
"inverse": "Verursacht"
},
"sortOrder": 4,
"system": true
}
Example request
curl -X PUT 'https://api.mbcom.cloud/api/desk/v1/enums/linkType/string' \
-H "Authorization: Bearer $ACCESS_TOKEN" \
-H 'Content-Type: application/json' \
--data '{"archived":false,"description":"Dieses Ticket wurde durch das verknüpfte verursacht","flags":[],"key":"caused_by","label":"Verursacht durch","props":{"inverse":"Verursacht"},"sortOrder":4,"system":true}'