Custom instructions
Sort
Moves one custom instruction to a new position in the ordered list, placing it between the two neighbouring sort keys given as position_precedes and position_follows.
PUT
/api/{tenant:minlength(2)}/v{version:apiVersion}/custom_instructions/sort
- Authorisation
- Minimum role: ADMIN
Request arguments
Request body example
Response
- Status
- 200 (OK)
- Type
- DTO_custom_instruction
- Wrapper
- DTO_response_wrap
- Other statuses
- 400 (BadRequest), 403 (Forbidden)
Response body example
| Name | Type | ReadOnly | Description |
|---|
| id | Int32 | | Id |
| position_follows | String | | Position follows |
| position_precedes | String | | Position precedes |
DTO_custom_instruction
| Name | Type | ReadOnly | Description |
|---|
| created_by | DTO_reference_user | ReadOnly | Created by |
| last_updated_by | DTO_reference_user | ReadOnly | Last updated by |
| id | Int32 | ReadOnly | Leave empty when Creating object |
| value | String | | The instruction text, 2 to 500 characters, which may contain placeholders as long as every one of them is a placeholder Deskhero knows |
| lexo_rank | String | ReadOnly | Lexo rank |
| trigger | ENUM custom_instruction_trigger | | Trigger |
| created | DateTime | ReadOnly | Created |
| last_updated | DateTime | ReadOnly | Last updated |
DTO_reference_user
| Name | Type | ReadOnly | Description |
|---|
| profile_pic | String | ReadOnly | Profile pic |
| email | String | ReadOnly | Email |
| id | Int32 | | Id |
| label | Object | ReadOnly | Label |
ENUM custom_instruction_trigger
| Value | Name | Description |
|---|
| 0 | UNKNOWN | UNKNOWN |
| 1 | NEW_TICKET_SUGGESTED_REPLY | NEW_TICKET_SUGGESTED_REPLY |
Generated Aug 4, 2026 18:37
