export_survey_link
Generate a unique survey link for a participant to complete a specific REDCap instrument using their record ID and instrument name.
Instructions
Get a unique survey link for a participant to complete an instrument.
The instrument must be enabled as a survey in REDCap. Returns an error if surveys are not enabled or the instrument is not a survey.
Args: record: Record ID of the participant. instrument: Internal name of the survey instrument. event: Event name (longitudinal projects only). repeat_instance: Repeat instance number (default 1).
Returns: The survey URL as a plain string.
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": {
"record": "<record>",
"instrument": "<instrument>"
},
"name": "export_survey_link"
}
}Input Schema
| Name | Required | Description | Default |
|---|---|---|---|
| event | No | ||
| record | Yes | ||
| instrument | Yes | ||
| repeat_instance | No |
Output Schema
| Name | Required | Description | Default |
|---|---|---|---|
| result | Yes |