Custom Field Associations
| API Endpoint | Namespace | Supported Generics |
|---|---|---|
member/<member_id>/custom-fields |
evclient.member.custom_fields(<member>).<method> |
CRUD |
Additional parameters¶
As member related custom fields are always bound to a specific member, the namespace used for custom field associations requires the member as constructor argument, to avoid passing it again to all endpoints:
| Name | Type | Description | Default |
|---|---|---|---|
member |
Member | int |
Identifies the member to modify custom field values on. Can be either an id or a Member object. |
required |
Generic Model Mappings¶
| Generic Model | MemberCustomField Model |
|---|---|
ModelType |
MemberCustomField |
CreateModelType |
MemberCustomFieldCreate |
UpdateModelType |
MemberCustomFieldUpdate |
Additional Methods¶
ensure_set ¶
Convenience method to set the custom field value on a member, no matter if it was set before already (PATCH) or not.
For select (s) and multiselect (a) custom fields, you can provide a list of values. Instead of using the value, the method will automatically fetch and select the options from selectOptions that have been introduced in January 2026.
Regarding rate limiting, be aware that this method requires at least two API calls.
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
custom_field_id
|
int
|
Custom field ID that should be set or changed |
required |
value
|
str | list[str]
|
New value the specified custom field should be set to |
required |