Skip to main content

CreateContactStoreScopedCustomFieldDefinitionInput

Defines the input details for creating a custom field definition in a contact store.

input CreateContactStoreScopedCustomFieldDefinitionInput {
  area: ContactStoreScopedCustomFieldArea!
  contactStoreId: ID!
  containsPersonalData: Boolean
  customFieldTabId: ID
  isMandatory: Boolean
  name: String!
  sortOrder: NonNegativeInt
  tags: [CreateCustomFieldDefinitionTagInput!]
  type: CustomFieldType!
  uniqueCode: String
}

Fields​

CreateContactStoreScopedCustomFieldDefinitionInput.area ● ContactStoreScopedCustomFieldArea! non-null enum​

The area in a contact store the custom field definition applies to.

CreateContactStoreScopedCustomFieldDefinitionInput.contactStoreId ● ID! non-null scalar​

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

CreateContactStoreScopedCustomFieldDefinitionInput.containsPersonalData ● Boolean scalar​

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

The default value is false.

CreateContactStoreScopedCustomFieldDefinitionInput.customFieldTabId ● ID scalar​

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

CreateContactStoreScopedCustomFieldDefinitionInput.isMandatory ● Boolean scalar​

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

The default value is false.

CreateContactStoreScopedCustomFieldDefinitionInput.name ● String! non-null scalar​

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

CreateContactStoreScopedCustomFieldDefinitionInput.sortOrder ● NonNegativeInt scalar​

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

The default value is 0.

CreateContactStoreScopedCustomFieldDefinitionInput.tags ● [CreateCustomFieldDefinitionTagInput!] list input​

The tags for a TAG custom field definition. Optional.

CreateContactStoreScopedCustomFieldDefinitionInput.type ● CustomFieldType! non-null enum​

The type of data collected in this custom field definition.

CreateContactStoreScopedCustomFieldDefinitionInput.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 contact store.

Member Of​

createContactStoreScopedCustomFieldDefinition mutation