Invite survey participants
limesurvey_invite_participantsSend survey invitation emails to specific participants or all eligible ones. Requires confirmation to actually send.
Instructions
Send survey invitation emails to selected or eligible participants. Requires confirm_send_email=true.
Calls LimeSurvey RemoteControl method invite_participants. Authentication uses the configured service account; do not provide a session key.
Input Schema
| Name | Required | Description | Default |
|---|---|---|---|
| survey_id | Yes | Numeric LimeSurvey survey ID. | |
| token_ids | No | Optional participant row IDs; null selects eligible participants. | |
| send_email | No | Actually send invitation emails. | |
| response_format | No | Output format. JSON preserves the complete structured result; Markdown is optimized for reading. | json |
| continue_on_error | No | Continue after individual email errors. | |
| confirm_send_email | Yes | Required acknowledgement that email may be sent to participants. |
Output Schema
| Name | Required | Description | Default |
|---|---|---|---|
| method | Yes | ||
| result | Yes | ||
| truncated | No | ||
| truncation_message | No |