create_assignment
Create Survey Solutions assignments, including open web interview links by setting web mode and unlimited quantity. Requires fieldwork write or admin write permission.
Instructions
Create a Survey Solutions assignment. Can create open web interview links by setting web_mode true and quantity -1. Requires fieldwork_write or admin_write permission.
Tool call template
Replace each placeholder with a value matching the input schema. Only required parameters are included; add optional parameters as needed.
{
"id": 1,
"jsonrpc": "2.0",
"method": "tools/call",
"params": {
"arguments": {
"responsible": "<responsible>",
"questionnaire_identity": "<questionnaire_identity>"
},
"name": "create_assignment"
}
}Input Schema
| Name | Required | Description | Default |
|---|---|---|---|
| No | |||
| profile | No | ||
| comments | No | ||
| password | No | ||
| quantity | No | Use -1 for unlimited/open web-link style assignments. | |
| web_mode | No | ||
| responsible | Yes | Responsible user login or user ID. If a login is supplied the HQ endpoint resolves it; if ambiguous, use an exact user ID from list_supervisors/list_supervisor_interviewers/get_user. | |
| target_area | No | ||
| identifying_data | No | ||
| protected_variables | No | ||
| questionnaire_identity | Yes | Questionnaire identity in GUID$Version format. | |
| is_audio_recording_enabled | No |