update_examinee
Update an examinee's name, status, or custom data in your RooQuiz team by business ID. Custom data is validated against field definitions, preventing masked values from corrupting phone fields.
Instructions
Update an examinee (a.k.a. respondent) in the current team, located by its examineeId (the business ID from list_examinees). Editable: name / status (active|disabled) / customData (validated against the team's examinee field definitions: required / unique / type / regex). email, tenant and examineeId cannot be changed. customData REPLACES the whole object and masked values are rejected: never re-send customData you just read, or you will wipe or corrupt phone fields — only write values the user gave you.
Input Schema
| Name | Required | Description | Default |
|---|---|---|---|
| name | No | New examinee name | |
| status | No | Enable (active) or disable the examinee | |
| customData | No | Custom field values as a code→value map, validated against the team's examineeFields definitions (required / unique / type / regex). The keys are that team's own field codes — get_examinee shows which codes exist, but only send values the user gave you: this replaces the whole customData object, and re-sending a value you read back (phone fields come back masked) wipes or corrupts it. | |
| examineeId | Yes | The examinee business ID (e.g. AB1234567890) to update |
Output Schema
| Name | Required | Description | Default |
|---|---|---|---|
| name | No | Masked name (J*n) | |
| No | Masked email (j***g@example.com); never pass it back as an argument | ||
| avatar | No | Uploaded avatar as { id, url } | |
| status | No | Account status | |
| tenant | No | Team (tenant) the respondent belongs to | |
| createdAt | No | ISO datetime of first sign-up | |
| updatedAt | No | ISO datetime of the last change | |
| customData | No | Team-defined custom fields; phone-typed values come back masked | |
| examineeId | No | Business ID of the respondent (e.g. AB1234567890) — use it to address them | |
| avatarPreset | No | Preset avatar key, when no image was uploaded | |
| emailVerified | No | Whether the email has been verified |