v1

latestOpenAPI 3.1.02026-08-067019120.8 KB

Sessions

Run an action in an interview session

Runs a named action in the specified interview session. The response is empty (204) unless the action ends with a response() call, in which case the response content is returned (200).

post/api/session/action

Request body

istring required

Interview filename.

sessionstring required

Session ID.

secretstring

Encryption secret.

actionstring required

Name of the action to run.

argumentsobject

Arguments to pass to the action.

persistent0 | 1

Set to 1 if the action shows a question block.

overwrite0 | 1

Set to 1 to overwrite the previous step rather than creating a new one.

read_only0 | 1

Set to 1 to run the action without saving interview answers.

Response

Action produced a response.

object required