Vereinsantrag
HandbuchDeveloperVereinsantrag.online
HandbuchDeveloperVereinsantrag.online
  1. CustomField
  • Welcome to the developer portal
  • Get your token
  • Rate-Limiting
  • API-Reference
    • Authentication
      • AuthenticationService
        • /auth/login
        • /auth/refresh
        • /auth/manage/info
        • /auth/manage/info
    • Information about your club
      • Club
        • Gets the information of the club.
        • Changes the information of the club.
        • Gets the logo of the club.
        • Changes the logo of the club.
      • Department
        • Retrieves all departments for the current club.
        • Creates a new department.
        • Retrieves a specific department by its ID.
        • Deletes a specific department by its ID.
        • Modifies an existing department.
        • Retrieves the settings for the departments.
        • Updates the settings for the departments.
      • Forms
        • Retrieves the membership form for the club.
        • Modifies the membership form for the club.
        • Retrieves the cancellation form for the club.
        • Modifies the cancellation form for the club.
      • Membership
        • Retrieves all memberships for the current club.
        • Creates a new membership.
        • Retrieves a specific membership by its ID.
        • Deletes a specific membership by its ID.
        • Modifies an existing membership.
      • CustomField
        • Retrieves all custom fields for the current club.
          GET
        • Creates a new custom field.
          POST
        • Retrieves a specific custom field by its internal name.
          GET
        • Deletes a specific custom field by its internal name.
          DELETE
        • Modifies an existing custom field.
          PUT
    • Submits
      • Cancellations
        • Get cancellation by id
        • Delete cancellation
        • Create new cancellation
        • Get cancellation PDF
        • Get cancellation CSV
        • Confirm cancellation
      • Changes
        • Create a new change request
        • Get change request by ID
        • Delete change request
        • Get change request PDF
        • Get change request CSV
        • Confirm change request
      • Memberships
        • Creates a new membership application
        • Retrieves a membership application
        • Deletes a membership application
        • Exports a membership application as PDF
        • Exports a membership application as CSV
        • Confirms a membership application
      • Submits
        • Retrieves all submissions.
        • Accepts a submission.
        • Denies a submission.
    • Reporting
      • Dashboard
        • Gets the count of new memberships.
        • Gets the count of new changes.
        • Gets the count of new cancellations.
        • Gets the membership chart data.
  1. CustomField

Creates a new custom field.

POST
https://api.vereinsantrag.de/v1/club/membership-form/custom-fields
CustomField
Request Request Example
Shell
JavaScript
Java
Swift
curl --location --request POST 'https://api.vereinsantrag.de/v1/club/membership-form/custom-fields' \
--header 'Content-Type: application/json' \
--data-raw ''
Response Response Example
201 - Example 1
{
  "internalName": "string",
  "isRequired": true,
  "caption": "string",
  "type": "Text",
  "category": "Member",
  "settings": "string",
  "order": 0
}

Request

Body Params application/json
Represents a custom field entity.
internalName
string  | null 
optional
Gets or sets the internal name of the custom field.
<= 50 characters
Match pattern:
^[a-zA-Z0-9_]+$
isRequired
boolean 
optional
Gets or sets a value indicating whether input is required for the custom field.
caption
string 
required
Gets or sets the caption of the custom field.
>= 1 characters<= 500 characters
type
enum<string> 
optional
Represents the types of custom fields available.
Allowed values:
TextYesNoDateSingleSelection
category
enum<string> 
optional
Represents the category of a custom field. The category determines the context in which the custom field will be displayed.
Allowed values:
MemberPaymentConfirmation
settings
string  | null 
optional
Gets or sets the settings for the custom field.
<= 500 characters
order
integer <int32>
optional
Gets or sets a order number for the custom field.
>= 0<= 100
Examples

Responses

🟢201Created
text/plain
Created
Body
Represents a custom field entity.
internalName
string  | null 
optional
Gets or sets the internal name of the custom field.
<= 50 characters
Match pattern:
^[a-zA-Z0-9_]+$
isRequired
boolean 
optional
Gets or sets a value indicating whether input is required for the custom field.
caption
string 
required
Gets or sets the caption of the custom field.
>= 1 characters<= 500 characters
type
enum<string> 
optional
Represents the types of custom fields available.
Allowed values:
TextYesNoDateSingleSelection
category
enum<string> 
optional
Represents the category of a custom field. The category determines the context in which the custom field will be displayed.
Allowed values:
MemberPaymentConfirmation
settings
string  | null 
optional
Gets or sets the settings for the custom field.
<= 500 characters
order
integer <int32>
optional
Gets or sets a order number for the custom field.
>= 0<= 100
🟠400Bad Request
Previous
Retrieves all custom fields for the current club.
Next
Retrieves a specific custom field by its internal name.
Built with