MngAddDesk¶
Requires set_customers. The target desk must match manager brand and desks scope loaded from the cached staff manager record.
Creates a CRM desk.
desk is normalized to uppercase by the server and must be unique within brand.
Request Parameters¶
| Name | Type | Required | Description |
|---|---|---|---|
desk |
string | Yes | Desk code, for example DESK_RETENTION |
brand |
string | Yes | Brand namespace |
name |
string | Yes | Human-readable desk name, up to 128 characters. Leading and trailing whitespace is trimmed |
status |
int | No | 0 active, 1 archived. Default 0 |
enable |
int | No | 1 enabled, 0 disabled. Default 1 |
manager_id |
int | No | Optional owner/team lead manager id |
sort_index |
int | No | UI ordering value |
Validation¶
name is required. A missing, empty, or whitespace-only name is rejected with HTTP 400 and error INVALID_DATA:
| Case | message |
|---|---|
name is not sent |
Missing required field: name |
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) |
Request¶
{
"command": "MngAddDesk",
"extID": "1",
"data": {
"desk": "DESK_RETENTION",
"brand": "default",
"name": "Retention",
"enable": 1,
"manager_id": 10,
"sort_index": 100
}
}
Response Data¶
{
"desk": {
"desk": "DESK_RETENTION",
"brand": "default",
"name": "Retention",
"status": 0,
"enable": 1,
"manager_id": 10,
"sort_index": 100,
"created_time": 1710000000,
"updated_time": 1710000000
}
}