Update a custom field
Partially updates a custom field. key cannot be changed (it is ignored), so values already stored on records keep working.
Endpoint
PATCH/custom-fields/:id
Body
Any writable attribute of the custom field object: name, fieldType, isRequired, options, system_currency_id, custom_field_category_id, position. A new name must still be unique for the entity type.
Request
Response
Returns the updated custom field object.
json
Errors
| Status | When |
|---|---|
400 Bad Request | The new name is already used for this entity type, or the currency rules for currency fields are not met. |
Report an issue with this documentation
Please log in to report issues with our documentation.