updateField

A mutation to update the properties of an existing Roadmap or Account-level Field of the following field types:

• List Field
• Multi-List Field
• Number Field
• Team Member Field
• Text Field

Note that this mutation will enforce any in-app restrictions on the updates to field properties. An operation for example attempting to modify a List Field to a Number Field will fail. Also, a field can only be promoted from Roadmap to Account-level but not in the other direction. An attempt to downgrade an Account-level field to a Roadmap-level field will fail.

This mutation only updates the properties of a Field and not the list of available values contained therein.

Sample Mutation

// Update field mutation
/* Example is for updating a dollar currency field to a euro currency field with 0 decimals.
If this mutation is used on a non-numeric field, the user can update the field name only.
*/
mutation {
 updateField (
   fieldID: "5e4dab706a8b06afcece7bde"
   name: "Funding (in Euros)"
   format: Currency
   currency: Euro
   decimalPlaces: 0
 ) {
   id
   name
   type
   isAccountField
   roadmap {
     id
     title
  }
 }
}

Sample Response

// Update field mutation successful result
{
 "data": {
   "updateField": {
   "id": "5e4dab706a8b06afcece7bde",
   "name": "Funding (in Euros)",
   "type": "Numeric",
   "isAccountField": false,
   "roadmap": {
     "id": "5e4d7d53caec436c46595378",
     "title": "Ecommerce Roadmap"
   }
  }
 }
}