Skip to main content
POST
/
questionnaires
/
{id}
/
start-for-clients
Starts a questionnaire survey for multiple clients with specified scheduling parameters.
curl --request POST \
  --url https://api.example.com/questionnaires/{id}/start-for-clients \
  --header 'Content-Type: application/json' \
  --data '
[
  {
    "clientId": 123,
    "questionnaireId": 123,
    "startDate": "2023-11-07T05:31:56Z",
    "interval": 123,
    "retries": 123,
    "intervalBackOffMultiplier": 123
  }
]
'

Path Parameters

id
integer<int32>
required

The unique identifier of the questionnaire to start.

Body

The list of client-specific survey start requests with scheduling details.

clientId
integer<int32>
questionnaireId
integer<int32>
startDate
string<date-time>
interval
integer<int32>
retries
integer<int32>
intervalBackOffMultiplier
integer<int32>

Response

OK