Update an interaction

Updates the properties of an existing interaction. Only the fields relevant to the interaction's current type have an effect; the type itself cannot be changed. A table cell's own value can be changed by updating that cell interaction directly. For a multiple-choice interaction, responses only updates the content of existing responses: each item's id must reference an existing response of the interaction, and only its name/failIf are changed. Responses are neither created, deleted nor reordered through this endpoint. For a table interaction, titles only renames existing columns: each item's id must reference an existing column of the table, and only its title is changed. Columns are neither added, removed nor reordered through this endpoint.

Path Params
string
required
length between 1 and 100

Consists of the subdomain. The tenantId for https://company.operations1.app/ is company.

integer
required
1 to 9007199254740991
Query Params
string
enum
Body Params
string
length between 1 and 10000
boolean
boolean
boolean
boolean
boolean
1 to 9007199254740991
length between 1 and 64
^[0-9]+(\.[0-9]+)?$
boolean
0 to 10
string
enum

Controls how toleranceUp and toleranceDown are interpreted. Defaults to absolute. For every type other than absolute a nominalValue is required, and the tolerances must be positive.

Allowed:
length between 1 and 64
^(-?[0-9]+(\.[0-9]+)?|\$\$[0-9]+\$\$)$

A tolerance value, either as the string representation of a number or as a document variable reference (e.g. $$12$$). How it is applied depends on toleranceType. null clears the tolerance.

length between 1 and 64
^(-?[0-9]+(\.[0-9]+)?|\$\$[0-9]+\$\$)$

A tolerance value, either as the string representation of a number or as a document variable reference (e.g. $$12$$). How it is applied depends on toleranceType. null clears the tolerance.

boolean

Whether toleranceUp is shown during execution. Defaults to false.

boolean

Whether toleranceDown is shown during execution. Defaults to false.

boolean

Whether a value below the tolerance fails the interaction. Requires toleranceDown to be set.

boolean

Whether a value above the tolerance fails the interaction. Requires toleranceUp to be set.

integer
1 to 9007199254740991
responses
array of objects
length ≥ 1
responses
integer
required
1 to 9007199254740991
string
required
length between 1 and 10000
enum

When the response fails the interaction. Omit it to keep the current condition, or send null to clear it.

titles
array of objects
length ≥ 1
titles
integer
required
1 to 9007199254740991
string
required
length between 0 and 100
integer
≥ 0

Zero-based position to move the interaction to among the process step's top-level interactions, or among the interactions sharing its condition if it is a conditional one. The other interactions are shifted accordingly. Must be lower than the number of these interactions, otherwise 400 is returned.

Headers
required

Defines the API version. Using a date is recommended for stability. Avoid using latest in production, as it refers to the most up-to-date functionality, which may include breaking changes. For more details, see our article on versioning.


Specifies the API version in date format (e.g., "2024-01-01"). Allowed values include 2025-04-21

Responses

Language
Credentials
Bearer
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json