Patch Field

PATCH {{protocol}}://{{instance_zuid}}.{{instances_api_url}}/{{instances_api_version}}/content/models/{{content_model_zuid}}/fields/{{field_zuid}}

  • label, name, settings, required, description, sort, relatedModelZUID, and relatedFieldZUID are the only updatable Fields.

  • The FULL settings object is required for any request.

  • Reactivation and updating Field values cannot happen in the same request - reactivation takes precedence.

Request Params

KeyDatatypeRequiredDescription
actionstringReactivate field using the value undelete

Request Body

{"name"=>"Patched Field Name", "settings"=>{"list"=>false, "options"=>{"First Option"=>1, "Second Option"=>2, "Third Option"=>3, "Fourth Option"=>4}}}

HEADERS

KeyDatatypeRequiredDescription
Content-Typestring

RESPONSES

status: OK

{"_meta":{"timestamp":"2024-03-22T15:37:11.673198932Z","totalResults":1,"start":0,"offset":0,"limit":1},"data":{"ZUID":"12-f0d4e9bbe5-tq17w3"}}