manage_recruitment
Act on the survey's live study at Prolific or CloudResearch Connect, using the API key saved in the app. One action per call: create the draft study or unlaunched project, change what participants see, pause, stop, close, or discard it, reject or report participants, block them from future Connect projects, message them, save participant groups, or unlink. Changes happen at the provider and some can't be undone. Nothing here pays participants: launching, approving, bonuses, and automatic approval are app-only. The prolific_* actions (and read_deploy's prolific_* includes) are in beta and need Beta Tester access; connecting Prolific by study link and completion code in edit_deploy doesn't. Read state back with read_deploy.
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": {
"survey_id": "<survey_id>"
},
"name": "manage_recruitment"
}
}Input Schema
| Name | Required | Description | Default |
|---|---|---|---|
| survey_id | Yes | Survey UUID (its recruitment integration must already be connected with edit_deploy recruitment.connect) | |
| prolific_review | No | Prolific only: reject submissions or ask for returns — the non-payment actions of the Prolific column in the Export response table. | |
| prolific_unlink | No | Prolific only: forget the linked Prolific study (the study on Prolific is untouched). | |
| prolific_update | No | Prolific only: pause or stop the linked study, or cancel its scheduled publish. Read it back with read_deploy include ["prolific_study"]. | |
| prolific_message | No | Prolific only: message participants of the linked study through Prolific. | |
| prolific_save_group | No | Prolific only: save participants as a Prolific participant group, to invite (or leave out) in a later study. | |
| cloudresearch_review | No | CloudResearch Connect only: reject or flag assignments — the non-payment actions of the CloudResearch column in the Export response table. | |
| cloudresearch_unlink | No | CloudResearch Connect only: forget the linked Connect project (the project on Connect is untouched). | |
| cloudresearch_update | No | CloudResearch Connect only: pause, close, or discard the linked Connect project, or cancel its scheduled launch. Read it back with read_deploy include ["cloudresearch_project"]. | |
| prolific_set_details | No | Prolific only: change what participants see on the linked study. Prolific lets a draft change all three; once published, only the description. Read it back with read_deploy include ["prolific_study"]. | |
| cloudresearch_message | No | CloudResearch Connect only: message participants of the linked project through Connect. | |
| prolific_create_study | No | Prolific only: create the study on Prolific as an unpublished draft with the survey's study link, completion codes (made here when the survey has none, and written into the Complete end screen's redirect), audience, quotas, and waves; it always leaves out the "Domandata block list" group (see prolific_block_participants), and returns never_twice saying who else was left out. Nothing is charged until it's published; publishing spends the Prolific balance, so the researcher publishes it in the app (Deploy → Recruitment → Prolific) once the survey is published with that change. | |
| cloudresearch_save_group | No | CloudResearch Connect only: save participants as a Connect participant group, to invite (or leave out) in a later project. | |
| cloudresearch_set_details | No | CloudResearch Connect only: change what participants see on the linked project — title, description, length, auto-pay window, time limit, instructions, requirements, sensitive-content flag, and language. Connect allows this only before launch. Read it back with read_deploy include ["cloudresearch_project"]. | |
| prolific_block_participants | No | Prolific only: add the participants behind these responses to the account's "Domandata block list" participant group (made if there is none). Every new study created from Domandata leaves that group out (prolific_targeting.block_list shows its size); studies made on Prolific itself don't, unless the group is added there as a blocklist screener. Remove people from the group on Prolific to undo. | |
| cloudresearch_create_project | No | CloudResearch Connect only: create the Connect project (unlaunched — nothing is charged) with the survey's study link, the payment, audience, and number of responses, then point the Complete end screen at the project's own return link. Launching spends the Connect balance, so the researcher launches it in the app (Deploy → Recruitment → CloudResearch Connect) once the survey is published with that change. | |
| cloudresearch_block_participants | No | CloudResearch Connect only: add the participants behind these responses to the account's universal block list ("Domandata block list", made if there is none), which keeps them out of every future project, including ones made on Connect. Remove people on Connect to undo. |
Output Schema
| Name | Required | Description | Default |
|---|---|---|---|
| result | Yes |