MngUpdateDesk¶
Requires set_customers. The current and target desk must match manager brand and desks scope loaded from the cached staff manager record.
Updates an existing CRM desk.
The desk is identified by brand and desk. The desk code itself is not renamed by this method.
Request Parameters¶
| Name | Type | Required | Description |
|---|---|---|---|
desk |
string | Yes | Existing desk code |
brand |
string | Yes | Brand namespace |
name |
string | No | Human-readable desk name, up to 128 characters. If omitted, the current name is kept. Leading and trailing whitespace is trimmed |
status |
int | No | 0 active, 1 archived |
enable |
int | No | 1 enabled, 0 disabled |
manager_id |
int | No | Optional owner/team lead manager id |
sort_index |
int | No | UI ordering value |
Validation¶
name may be omitted, but a sent name cannot clear the desk name. An empty or whitespace-only name is rejected with HTTP 400 and error INVALID_DATA:
| Case | message |
|---|---|
name is "" or contains only whitespace |
Field 'name' must not be empty |
name is longer than 128 characters |
Field 'name' length is greater than maximum allowed (128) |
Existing desks without a name can still be updated without sending name.
Request¶
{
"command": "MngUpdateDesk",
"extID": "1",
"data": {
"desk": "DESK_RETENTION",
"brand": "default",
"name": "Retention Team",
"enable": 1,
"manager_id": 10
}
}
Response Data¶
{
"desk": {
"desk": "DESK_RETENTION",
"brand": "default",
"name": "Retention Team",
"status": 0,
"enable": 1,
"manager_id": 10,
"sort_index": 100,
"created_time": 1710000000,
"updated_time": 1710000100
}
}