> This page is for API Reference & Tools.

> For clean Markdown of any page, append .md to the page URL.
> For a complete documentation index, see https://docs.moveworks.com/llms.txt.
> For AI client integration (Claude Code, Cursor, etc.), connect to the MCP server at https://docs.moveworks.com/_mcp/server.

# Ticket Actions

> Read and update Ticket Actions through the Moveworks Configuration API: endpoints, fields and examples.

`tool.ticket.action`

In-bot ticket actions and display behaviour.

* **Endpoint:** `/tool/ticket/action`  |  **Methods:** GET, PATCH
* **Request shape:** one per organization, so there is no `id`. It already exists: read it with `GET`, then `PATCH` the fields you want to change. Fields go at the top level of the JSON body, with no `resource` wrapper.
* **Updates:** a JSON merge-patch. Send only the fields you change, plus `version: {num, change_description}` with the `num` from your last read. Lists and maps you send replace the stored ones whole.

### Endpoints

All paths are relative to `https://api.moveworks.ai/configurations/v1alpha1`. Each endpoint page lists the request and response schema, an example, and the errors it can return.

| Method  | Path                  | Endpoint reference                                                                                       |
| ------- | --------------------- | -------------------------------------------------------------------------------------------------------- |
| `GET`   | `/tool/ticket/action` | [Get ticket actions](/api-reference/configuration-api/ticketing/ticket-actions/get-ticket-actions)       |
| `PATCH` | `/tool/ticket/action` | [Update ticket actions](/api-reference/configuration-api/ticketing/ticket-actions/update-ticket-actions) |

### Fields

| Field                                                      | Type                         | Required  | Notes                                                                                                                                                                                             |
| ---------------------------------------------------------- | ---------------------------- | --------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| `ticket_display`                                           | TicketDisplaySettings        |           | How tickets are displayed to users in the assistant.                                                                                                                                              |
| `unsupported_ticket_types`                                 | array\<string>               |           | Ticket types the assistant does not support for checking status and other ticket actions. Allowed values: DEFAULT, INCIDENT, REQUEST, REQUEST_ITEM, CALL, TASK, MISC, UNIVERSAL_REQUEST, HR_CASE. |
| `default_ticket_type_to_file`                              | string                       |           | Ticket type that is always filed. DEFAULT lets Moveworks choose the type automatically. Allowed values: DEFAULT, INCIDENT, REQUEST, REQUEST_ITEM, CALL, TASK, MISC, UNIVERSAL_REQUEST, HR_CASE.   |
| `comment_capture_before_reopening_enabled`                 | boolean                      |           | If true, users can add a comment before reopening a ticket.                                                                                                                                       |
| `askme_on_ticket_route_filter_dsl`                         | string                       |           | Moveworks DSL rule selecting the users who receive AskMe reach-outs from a ticket.                                                                                                                |
| `ticket_interception_for_assistant_enabled_dsl`            | string                       |           | Moveworks DSL rule that turns on ticket interception in the AI Assistant for matching users.                                                                                                      |
| `attachment_upload_enabled_dsl`                            | string                       |           | Moveworks DSL rule that offers users an option to upload attachments to add details to a ticket draft.                                                                                            |
| `hide_reopen_button_if_ticket_state_is_closed_enabled_dsl` | string                       |           | Moveworks DSL rule that, when it matches, hides the 'Reopen Ticket' button for tickets in the CLOSED state.                                                                                       |
| `live_agent_enabled_dsl`                                   | string                       |           | Moveworks DSL rule that offers live agent handoff as an alternative to filing a ticket.                                                                                                           |
| `live_agent_link_enabled_dsl`                              | string                       |           | Moveworks DSL rule that includes a live agent link in ticket comments.                                                                                                                            |
| `ticket_handoff_history_passing_options`                   | TicketHandoffHistorySettings |           | How conversation history is passed to the ticketing system when a ticket is filed.                                                                                                                |
| `updated_time`                                             | string                       | read-only | When the configuration was last updated.                                                                                                                                                          |
| `updated_by`                                               | string                       | read-only | Who last updated the configuration.                                                                                                                                                               |
| `version`                                                  | Version                      |           | Document version. On update, send back the num from your last read.                                                                                                                               |

### Document fields (example)

The document as `GET` returns it. To change any of these, send only the fields you want to change in the `PATCH` body.

```json
{
  "ticket_display": {
    "customer_ticket_state_display_enabled": true,
    "assignee_display_enabled": true,
    "ticket_link_to_reference_pop_up_enabled": true
  },
  "unsupported_ticket_types": [],
  "default_ticket_type_to_file": "DEFAULT",
  "comment_capture_before_reopening_enabled": true,
  "askme_on_ticket_route_filter_dsl": "true",
  "ticket_interception_for_assistant_enabled_dsl": "true",
  "attachment_upload_enabled_dsl": "true",
  "hide_reopen_button_if_ticket_state_is_closed_enabled_dsl": "true"
}
```