Update Dependent Custom Field name and order

In dynamic environments, teams often need to update the labeling and order of dependent custom fields to keep runbooks clear and organized. Using the Cutover Public API, you can retrieve the parent field, identify dependent field IDs, and update their display name and order to control how attributes appear to users.

‍

1.Retrieve the parent custom field

 Identify the parent field to locate the dependent field. Use the following request:

‍

GET /custom_fields/647
Authorization: Bearer <your_api_token>

‍

2.Identify the dependent custom field ID

In the parent custom field’s JSON response, locate the child field you want to update.

• Navigate to ^{data.relationships.dependent_custom_fields.data}. This array lists all dependent custom fields.
  
• Pull the ^id of the dependent field to modify. For example: 

{
  "data": {
    "id": "647",
    "type": "custom_field",
    "relationships": {
      "dependent_custom_fields": {
        "data": [
          { "id": "648", "type": "custom_field" },
          { "id": "649", "type": "custom_field" }  // <-- Use this ID
        ]
      }
    }
  }
}

‍

3.Update the dependent field's name and order

Use the dependent field’s ID to send the update request.

• Call _{PATCH /custom_fields/{id}} with the dependent field ID from step 2.
  
• Provide new values for ^display_name and/or ^order attributes. The order is typically an integer that dictates the field's position relative to its siblings. By default, all custom fields are set with an order value of 0 on creation.

{
  "display_name": "Renamed RTO Field",
  "order": 2
}

‍

Notes:

• ^display_name → The new label for the field.
  
• ^order → Integer controlling the field’s position relative to sibling fields.

4.Verify the change

After the API call succeeds:

• Open a runbook using this custom field in the Cutover UI.
  
• Confirm that the dependent field now appears with the updated name and in the correct order.

Best practices

• Always retrieve the parent field first to ensure the correct dependent field ID is updated.
• Test changes in a staging environment before production.