Skip to navigation

/record/{record_uuid}/{field_uuid}/{option_uuid}/{selected|unselected}

View as Markdown

Select / Unselect a Field Option on a Record

Sets the selected or unselected state of a specific option on a radio or checkbox/multi-select field for a given record. The desired action is encoded directly in the final path segment as the literal string selected or unselected.


HTTP Method & URL

PUT {{url}}/record/{record_uuid}/{field_uuid}/{option_uuid}/{selected|unselected}

Example:

PUT {{url}}/record/c00710bb4560d99280ee6b86a5fd/e4bd3c7024d12f5c80da99fffd63/6b40829ca6e77002513def5f7406/unselected

Path Parameters

ParameterTypeDescription
record_uuidstringThe UUID of the record whose field option is being updated.
field_uuidstringThe UUID of the field (must be a radio or checkbox/multi-select field type).
option_uuidstringThe UUID of the specific option to select or unselect.
selectedunselectedstring (literal)

Authentication

Bearer Token — automatically set via a pre-request script.

The script uses the apiuser, apipass, and url environment variables to obtain and inject a JWT Bearer token into the request. Ensure these variables are set in the active environment before sending.


Request Body

None. This is a bodyless PUT request. All parameters are passed through the URL path. No Content-Type header or request body is required.


Supported Field Datatypes

This endpoint operates on the following ODR field types:

  • Radio buttons — Single-select fields where only one option may be selected at a time.

  • Checkbox / Multi-select — Fields that allow multiple options to be selected simultaneously; each option is toggled independently.


Behavior Notes

  • Radio fields: Selecting a new option automatically unselects the previously selected option. Only one option can be active at a time.

  • Checkbox / multi-select fields: Each option is toggled independently. Selecting one option does not affect the state of other options on the same field.

  • Idempotent unselect: Sending unselected for an option that is already unselected is a no-op — the request succeeds without changing any state.

  • Idempotent select: Sending selected for an option that is already selected is a no-op — the request succeeds without changing any state.


Response Behavior

ScenarioExpected Result
Option successfully selected or unselected200 OK with a success response body.
Invalid record_uuid, field_uuid, or option_uuid404 Not Found or appropriate error response.
Field type does not support option selectionError response indicating incompatible field type.
Authentication failure (missing or invalid token)401 Unauthorized.
Malformed URL / missing path segments400 Bad Request or routing error.

Response headers

Access-Control-Allow-OriginstringOptional
Access-Control-Allow-MethodsstringOptional
Access-Control-Allow-HeadersstringOptional
Access-Control-Expose-HeadersstringOptional
Access-Control-Max-AgestringOptional
Cache-ControlstringOptional
X-Debug-TokenstringOptional
Keep-AlivestringOptional

Response

OK
database_uuidstring
internal_idinteger
record_namestring
record_uuidstring
template_uuidstring
metadata_for_uuidstring
_record_metadataobject
fieldslist of objects
recordslist of any