customFieldCreate

Graphql fields and variables for the customFieldCreate mutation

Create a custom field definition

Scope required: admin:write

For a complete list of input attributes see the CustomFieldAttributes type

mutation customFieldCreate ($attributes: CustomFieldAttributes!) {
  customFieldCreate (attributes: $attributes) {
      customField {
        createdAt
        fieldType
        formColumn
        graphqlFieldName
        id
        label
        name
        parentObject
        position
        required
        size
        updatedAt
      }
      errors
  }
}

Arguments

{
  "attributes": {
    "label": "",
    "name": "",
    "fieldType": "",
    "parentObject": "",
    "position": 123,
    "size": "",
    "required": true
  }
}

Name	Type	Description
attributes	CustomFieldAttributes

Response

Name	Type	Description
customField	CustomField
errors	List (String)