Skip to content

Custom Field

Representative Model Class Update Model Class Create Model Class
CustomField CustomFieldUpdate CustomFieldCreate

Custom fields can be used in a variety of places. Currently, the supported types include member custom fields, event custom fields, contact details custom fields and inventory custom fields.

Custom Field Values

This endpoint manages the custom fields themselves, not their values.

additional class-attribute instance-attribute 

additional: OptionsField = None

collection class-attribute instance-attribute 

collection: EasyVereinReference | None = None

color class-attribute instance-attribute 

color: HexColor = None

description class-attribute instance-attribute 

description: str | None = Field(default=None, max_length=124)

kind class-attribute instance-attribute 

kind: Literal['a', 'b', 'ba', 'ca', 'iv', 't', 'u', 'ic', 'c', 'e', 'h', 'j', 'i', 'k'] | None = None

Kind defines in which context this custom field is used. Unfortunately only some possible values are documented in the API spec:

  • e: for members
  • h: for events
  • j: for contact details
  • i: for inventory function

It is not even possible to set other fields except the ones mentioned before in the portal, so not sure what the other values are meant for.

member_dsgvo class-attribute instance-attribute 

member_dsgvo: bool | None = None

member_edit class-attribute instance-attribute 

member_edit: bool | None = None

member_show class-attribute instance-attribute 

member_show: bool | None = None

name class-attribute instance-attribute 

name: str | None = Field(default=None, max_length=200)

needsAdminApproval class-attribute instance-attribute 

needsAdminApproval: bool | None = None

orderSequence class-attribute instance-attribute 

orderSequence: PositiveIntWithZero | None = None

position class-attribute instance-attribute 

position: PositiveIntWithZero | None = None

settings_type class-attribute instance-attribute 

settings_type: Literal['t', 'f', 'z', 'd', 'c', 'r', 's', 'a', 'b', 'm'] | None = None

Settings type defines which type of field this custom field should be. Possible values:

  • t: Single line text field
  • f: Multiline text field
  • z: Digit text field
  • d: Date field
  • c: Checkbox
  • r: Date range field (from date and to date)
  • s: Select field
  • a: Multiselect field
  • b: File upload
  • m: reminder

If type is set to s or a, the possible options need to be defined in the additional field

short class-attribute instance-attribute 

short: str | None = Field(default=None, max_length=4)