New: Kith open-sources its ATS.Read why
Skip to Content
Inputs

UpdateFieldDefinitionInput

What to change on a workspace field. A field left out is unchanged; null clears it, except the label and the type. Its kind of record and its key never change.

input UpdateFieldDefinitionInput {
  fieldDefinitionId: ID!
  fillMode: FieldFillMode
  instruction: String
  label: String
  options: [String!]
  type: FieldType
}

Fields

UpdateFieldDefinitionInput.fieldDefinitionId · ID! non-null scalar

The field's id.

UpdateFieldDefinitionInput.fillMode · FieldFillMode enum

How the AI may fill it. Null to stop the AI filling it.

UpdateFieldDefinitionInput.instruction · String scalar

What the AI should read for and write. Cannot be cleared while fillMode is set.

UpdateFieldDefinitionInput.label · String scalar

The name people see, from 1 to 300 characters. It cannot be cleared.

UpdateFieldDefinitionInput.options · [String!] list scalar

The choices of a SELECT or MULTI_SELECT field. Replaces the list, and null empties it. 100 at most.

UpdateFieldDefinitionInput.type · FieldType enum

What kind of value it holds. Values already stored are not converted. It cannot be cleared.

Member Of

updateFieldDefinition mutation