Create Respondent
create_respondentCreates a respondent in the survey's respondent list (the list 'External for {survey}' is auto-created, unknown custom fields are auto-created too). PersonalizedID is optional and NOT checked for uniqueness; when omitted, the respondent's links use the generated internal ID. sendInvitation: the invitation email is sent ONLY when explicitly true — leave it off unless the user clearly asked to send invitations. Returns the contact's PERSONAL survey link (surveyLink, …/Share/{code}/{personalizedID}); responses through it are attributed to this contact. Verified by readback: the respondent is read back after the write and the reply reports what is actually stored, not merely the acknowledgement of the write.
Input Schema
| Name | Required | Description | Default |
|---|---|---|---|
| code | Yes | Survey publication code — the 8-character code from the survey's public link (e.g. 1a2b3c4d). Returned by list_surveys. | |
| respondent | Yes | The respondent to create: firstName, lastName, email, language, personalizedID and custom fields. | |
| sendInvitation | No | Send invitation email. |
Output Schema
| Name | Required | Description | Default |
|---|---|---|---|
| message | No | What the call did, verified, refused or previewed — the complete human-readable outcome. | |
| preview | No | true when the call was a preview (confirm not passed): nothing was changed. |