Custom instructions / List
Returns all custom instructions.
Route: /api/{tenant:minlength(2)}/v{version:apiVersion}/custom_instructions
Method: GET
Authorisation: Minimum role: USER
Request Arguments
| Name | Type | Source |
|---|
Request body example
Response object
Response status: 200 (OK)
Response type: DTO_custom_instruction[]
Wrapper: DTO_response_wrap
Other response statuses: 400 (BadRequest), 403 (Forbidden)
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 | Value | |
| 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 |
