Skip to navigation

Update ticket nudges

View as Markdown

Changes the fields you send and returns the full updated document.

Send only the fields you want to change, plus version with the num from your last read and a change_description. This is a JSON merge-patch: a field you leave out keeps its stored value, and every list or map you send replaces the stored one whole.

Authentication

AuthorizationBearer

JWT bearer token authentication. Include the Configuration API key in the Authorization header as ‘Bearer <token>’.

Request

This endpoint expects an object.
versionobjectRequired
Document version. On update, send back the num from your last read.
max_nudge_count_for_ticketlongOptional
Maximum number of times a user can be nudged about an inactive ticket. Must be greater than 0.
nudge_interval_start_offset_dayslongOptional
Start of the window, in days since the ticket was last updated, in which tickets are eligible for nudges.
nudge_interval_end_offset_dayslongOptional
End of the window, in days since the ticket was last updated, in which tickets are eligible for nudges.
nudge_inactivity_threshold_dayslongOptional
Number of days without a new comment before a ticket is eligible for a nudge.
nudge_reminder_threshold_dayslongOptional
Minimum number of days between nudges for the same ticket.
nudge_reminders_enabled_dslstringOptional

Moveworks DSL rule that turns on in-bot nudge reminders for matching users who drop off. Must be a valid MWDSL expression.

nudge_poller_enabledbooleanOptional
If true, Moveworks polls for tickets that need nudge notifications.

Response

The updated ticket nudges, at its new version
max_nudge_count_for_ticketlongOptional
Maximum number of times a user can be nudged about an inactive ticket. Must be greater than 0.
nudge_interval_start_offset_dayslongOptional
Start of the window, in days since the ticket was last updated, in which tickets are eligible for nudges.
nudge_interval_end_offset_dayslongOptional
End of the window, in days since the ticket was last updated, in which tickets are eligible for nudges.
nudge_inactivity_threshold_dayslongOptional
Number of days without a new comment before a ticket is eligible for a nudge.
nudge_reminder_threshold_dayslongOptional
Minimum number of days between nudges for the same ticket.
nudge_reminders_enabled_dslstringOptional

Moveworks DSL rule that turns on in-bot nudge reminders for matching users who drop off.

nudge_poller_enabledbooleanOptional
If true, Moveworks polls for tickets that need nudge notifications.
updated_timedatetimeOptionalRead-only
When the configuration was last updated.
updated_bystringOptionalRead-only
Who last updated the configuration.
versionobjectOptional
Document version. On update, send back the num from your last read.

Errors

400
Bad Request Error
401
Unauthorized Error
403
Forbidden Error
409
Conflict Error
429
Too Many Requests Error
500
Internal Server Error