TRMNL Octri Demo
POST/api/plugin_settings/custom_fields/verifications

Check the custom fields YAML of a recipe

Validates the YAML a recipe author writes under custom_fields, the form its installers fill in, without saving it. Each entry needs keyname, field_type and name.

  • IdempotentThe SDK sends Idempotency-Key, so a retried request is only applied once.

1 body field
custom_fieldsstringrequired
The custom fields as a YAML list

3 status codes
200Valid
dataobjectoptional
401Unauthorized
errorstringoptional
422custom_fields that is not a string

Error handling

A 401 is returned: Unauthorized. A 422 is returned: custom_fields that is not a string.