Custom instructions
Get one
Returns one custom instruction with its text, its trigger and the sort key that fixes its place in the order the AI receives them.
GET
/api/{tenant:minlength(2)}/v{version:apiVersion}/custom_instructions/{id}
Request arguments
| Name | Type | Source |
|---|---|---|
| id | Int32 |
Request body example
Response
Response body example
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 |
| String | ReadOnly | ||
| 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