Skip to main content

UpdateCeContactStoreScopedCustomFieldDefinitionInput

Defines the input details for updating an existing custom field definition for a continuing education contact store.

input UpdateCeContactStoreScopedCustomFieldDefinitionInput {
  ceContactStoreId: ID!
  containsPersonalData: Boolean
  customFieldDefinitionId: ID!
  customFieldTabId: ID
  isMandatory: Boolean
  name: String
  sortOrder: NonNegativeInt
  tags: [UpdateCustomFieldDefinitionTagInput!]
  uniqueCode: String
}

Fields​

UpdateCeContactStoreScopedCustomFieldDefinitionInput.ceContactStoreId ● ID! non-null scalar​

The identifier of the continuing education contact store the custom field definition is associated with.

UpdateCeContactStoreScopedCustomFieldDefinitionInput.containsPersonalData ● Boolean scalar​

A flag indicating whether the custom field includes sensitive personal data. Optional.

UpdateCeContactStoreScopedCustomFieldDefinitionInput.customFieldDefinitionId ● ID! non-null scalar​

The identifier of the custom field definition.

UpdateCeContactStoreScopedCustomFieldDefinitionInput.customFieldTabId ● ID scalar​

The identifier of the custom field tab to associate the custom field definition with. Optional.

UpdateCeContactStoreScopedCustomFieldDefinitionInput.isMandatory ● Boolean scalar​

A flag indicating whether the custom field requires a value to be completed. Optional.

UpdateCeContactStoreScopedCustomFieldDefinitionInput.name ● String scalar​

A UTF-8 string representing the name of the custom field definition. Optional.

UpdateCeContactStoreScopedCustomFieldDefinitionInput.sortOrder ● NonNegativeInt scalar​

Defines the order that the custom field definition is sorted by in lists. Optional.

If set to null, will default to 0.

UpdateCeContactStoreScopedCustomFieldDefinitionInput.tags ● [UpdateCustomFieldDefinitionTagInput!] list input​

The tags for a TAG custom field definition. Optional.

Passing null or an empty list will remove all of the tags from the custom field definition. Omitting the input value entirely will keep the existing tags as-is.

When passing a list, for any existing tags where the id is not provided the tag will be removed.

UpdateCeContactStoreScopedCustomFieldDefinitionInput.uniqueCode ● String scalar​

A customer supplied, UTF-8 string value that represents a unique code for the custom field definition. Optional.

The value must be unique across all custom field definitions for a continuing education contact store.

Member Of​

updateCeContactStoreScopedCustomFieldDefinition mutation