Skip to navigation

Refresh modal

View as Markdown

Re-evaluates the modal’s conditional field rules against the values entered so far. Call it after changing the value of a field flagged with triggers_refresh, then re-render the modal from the response.

The response carries every field with its state re-resolved, with one exception: choice fields omit their options list. Re-apply the options you received when you first retrieved the modal.

Nothing is persisted: the stored modal is never modified, and a refresh never changes the title. Send all current values, since rules are re-evaluated against the snapshot you provide and a partial map yields partially resolved state.

Authentication

AuthorizationBearer

JWT bearer token authentication. Obtain an access token from the Moveworks auth endpoint and include it in the Authorization header as ‘Bearer <token>’.

Path parameters

conversation_idstringRequired

A base-62 identifier prefixed by a short resource type

response_idstringRequired

A base-62 identifier prefixed by a short resource type

message_idstringRequired

A base-62 identifier prefixed by a short resource type

modal_idstringRequired

Opaque modal identifier, taken from the modal_action.modal_id of the action that surfaced this modal. Pass it back exactly as received.

Headers

Assistant-NamestringRequired
The Moveworks assistant identifier that was configured for your organization.

Request

This endpoint expects an object.
valuesmap from strings to objectsRequired

All current field values, keyed by the field’s name. Rules are re-evaluated against this snapshot, so a partial map yields partially resolved state.

Response headers

x-trace-idstringOptional
A unique identifier used to trace your request within the Moveworks system

Response

Modal re-resolved successfully

modal_idstring

Opaque modal identifier, echoed from the MODAL_ACTION that surfaced this modal.

titlestring
Modal title to display.
fieldslist of objects
Fields in display order. Render them in the order returned.

Errors

400
Bad Request Error
401
Unauthorized Error
403
Forbidden Error
404
Not Found Error
429
Too Many Requests Error
500
Internal Server Error