Update Custom Field

Request format

In order to update a custom field you must send a JSON:API spec JSON object representing a custom field.

Differences from creation

This endpoint works much in the same way as the Create Custom Field.

There are two exceptions to this:

1. field_type cannot be updated, this is because any custom_attributes that have already been created for this custom_field will have a response based on the field type (e.g. custom_fields that have a field type of date will have been answered with a date and therefore can't be changed to boolean). If you want to change the field_type you should create a new custom_field (and optionally delete the existing one).
2. resource_type cannot be updated.

Examples

{
  "data": {
    "id": "1",
    "type": "custom_fields",
    "attributes": {
      "name": "Updated custom field"
    }
  }
}