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

CreateFieldDefinitionInput

A workspace field to add.

input CreateFieldDefinitionInput {
  entity: FieldEntity!
  fillMode: FieldFillMode
  instruction: String
  key: String!
  label: String!
  options: [String!]
  type: FieldType
}

Fields

CreateFieldDefinitionInput.entity · FieldEntity! non-null enum

The kind of record it is on. It never changes.

CreateFieldDefinitionInput.fillMode · FieldFillMode enum

How the AI may fill it. Left out, the AI does not fill it.

CreateFieldDefinitionInput.instruction · String scalar

What the AI should read for and write. Required when fillMode is given.

CreateFieldDefinitionInput.key · String! non-null scalar

Its stable name: a lower case letter, then up to 62 lower case letters, digits or underscores. It never changes.

CreateFieldDefinitionInput.label · String! non-null scalar

The name people see, from 1 to 300 characters.

CreateFieldDefinitionInput.options · [String!] list scalar

The choices of a SELECT or MULTI_SELECT field. 100 at most. Other types take none.

CreateFieldDefinitionInput.type · FieldType enum

What kind of value it holds. TEXT when left out.

Member Of

createFieldDefinition mutation