Skip to navigation
Conversations APIConversations APIModals

Submit modal

View as Markdown

Submits the filled values of a modal.

Rule evaluation is authoritative on the server: fields that resolve to hidden are neither required nor persisted, and DISPLAY blocks are never submitted.

The response is an acknowledgement receipt, not the outcome of the downstream action. The follow-up assistant response arrives on the conversation through the usual response channels.

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

Values to submit, keyed by the field’s name.

Response headers

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

Response

Modal submitted successfully
statusenum
Modal submission status.
Allowed values:
receipt_textstringOptional
Acknowledgement that the values were accepted. This is a receipt, not the outcome of the downstream action.

Errors

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