Create an interaction

Creates a single interaction in a process step. name and type are required, the remaining properties depend on the type. For a multiple-choice interaction the choices given in responses are created as well. For a number interaction toleranceUp and toleranceDown are interpreted according to toleranceType, shown during execution via visibleToleranceUp / visibleToleranceDown and turned into a failure via failIfLess / failIfMore. A table interaction is created as an empty 2x3 table; its columns and rows cannot be configured here, and any columns or rows sent in the payload are ignored. The name is stored for the locale given by lang, which defaults to the document default locale. The interaction is inserted at position, or appended at the end of the process step if it is omitted.

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