> 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 Nudges

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

`tool.ticket.nudge`

* **Endpoint:** `/tool/ticket/nudge`  |  **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/nudge` | [Get ticket nudges](/api-reference/configuration-api/ticketing/ticket-nudges/get-ticket-nudges)       |
| `PATCH` | `/tool/ticket/nudge` | [Update ticket nudges](/api-reference/configuration-api/ticketing/ticket-nudges/update-ticket-nudges) |

### Fields

| Field                              | Type    | Required  | Notes                                                                                                     |
| ---------------------------------- | ------- | --------- | --------------------------------------------------------------------------------------------------------- |
| `max_nudge_count_for_ticket`       | integer |           | Maximum number of times a user can be nudged about an inactive ticket. Must be greater than 0.            |
| `nudge_interval_start_offset_days` | integer |           | Start of the window, in days since the ticket was last updated, in which tickets are eligible for nudges. |
| `nudge_interval_end_offset_days`   | integer |           | End of the window, in days since the ticket was last updated, in which tickets are eligible for nudges.   |
| `nudge_inactivity_threshold_days`  | integer |           | Number of days without a new comment before a ticket is eligible for a nudge.                             |
| `nudge_reminder_threshold_days`    | integer |           | Minimum number of days between nudges for the same ticket.                                                |
| `nudge_reminders_enabled_dsl`      | string  |           | Moveworks DSL rule that turns on in-bot nudge reminders for matching users who drop off.                  |
| `nudge_poller_enabled`             | boolean |           | If true, Moveworks polls for tickets that need nudge notifications.                                       |
| `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
{
  "max_nudge_count_for_ticket": 1,
  "nudge_interval_start_offset_days": 1,
  "nudge_interval_end_offset_days": 1,
  "nudge_inactivity_threshold_days": 1,
  "nudge_reminder_threshold_days": 1,
  "nudge_reminders_enabled_dsl": "true",
  "nudge_poller_enabled": true
}
```