Vereinsantrag
Handbuch
DeveloperVereinsantrag.online
Handbuch
DeveloperVereinsantrag.online
  1. Forms
  • Wilkommen zu Vereinsantrag 🎉
  • Registrierung und Vereinsdaten
  • Mitgliedschaften und Abteilungen
  • Formulare konfigurieren und veröffentlichen
  • Formular Design
  • Weitere Felder hinzufĂŒgen
  • Datenschutz
  • AntrĂ€ge online empfangen und verwalten
  • Einstellungen
  • Developer
    • Welcome to the developer portal
    • Get your token
    • Rate-Limiting
    • API-Reference
      • Authentication
        • AuthenticationService
          • /auth/login
          • /auth/refresh
          • /auth/manage/info
          • /auth/manage/info
        • Users
          • Get all users for the current club (Admin only)
          • Create a new user in the current club without password - user receives email invitation (Admin only)
          • Get user by ID within the current club
          • Update user details within the current club
          • Delete a user from the current club (Admin only)
          • Resend password setup email to a user (Admin only)
          • Get available roles (Admin only)
      • 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
          • Get Membership Form
            GET
          • Modify Membership Form
            POST
          • Get Cancellation Form
            GET
          • Modify Cancellation Form
            POST
          • Get Form Design
            GET
          • Updates form Design
            POST
        • 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.
          • Creates a new custom field.
          • Retrieves a specific custom field by its internal name.
          • Deletes a specific custom field by its internal name.
          • Modifies an existing custom field.
        • DataPrivacy
          • Retrieves the data privacy settings for the club.
          • Updates the data privacy settings for the club.
        • Settings
          • Get email template
          • Set email template
          • Reset email template
          • Get system email template
          • Get SMTP settings
          • Set SMTP settings
          • Test SMTP connection
      • Submits
        • Cancellations
          • Get cancellation by id
          • Delete cancellation
          • Update cancellation submission
          • Create new cancellation
          • Get cancellation PDF
          • Get cancellation CSV
          • Export cancellation as text
          • Confirm cancellation
          • Resends the confirmation email for a cancellation application
          • Retrieves the history for a specific cancellation submission.
        • Changes
          • Create a new change request
          • Get change request by ID
          • Delete change request
          • Update change submission
          • Get change request PDF
          • Get change request CSV
          • Export change request as text
          • Confirm change request
          • Resends the confirmation email for a change membership application
          • Retrieves the history for a specific change submission.
        • Memberships
          • Creates a new membership application
          • Retrieves a membership application
          • Deletes a membership application
          • Update membership application
          • Exports a membership application as PDF
          • Exports a membership application as CSV
          • Exports a membership application as text
          • Confirms a membership application
          • Resends the confirmation email for a membership application
          • Retrieves the history for a specific membership submission.
        • Submits
          • Retrieves all submissions.
          • Accepts a submission.
          • Denies a submission.
          • Starts a PDF export job
          • Downloads exported files as ZIP
          • Returns export job progress
          • Starts a CSV export job
      • 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.
        • ReportService
          • /test
  • Schemas
    • Schemas
    • BackgroundImageSettings
    • KpiCountResult
    • AccessTokenResponse
    • CancellationMode
    • ChangeClubInfo
    • CancellationSubmit
    • BackgroundSettings
    • CancellationPatchDto
    • CreateUserRequest
    • ChangeCustomFieldSchema
    • MembershipCountChartResult
    • ForgotPasswordRequest
    • ChangeMembershipSchema
    • CancellationSubmitResponse
    • ClubInfo
    • ChangesSubmit
    • HttpValidationProblemDetails
    • FamiliySubmit
    • CancellationSubmitPatchRequest
    • InfoRequest
    • ClubLogo
    • Gender
    • InfoResponse
    • DepartmentSchema
    • ConsentMediaType
    • MembershipSubmit
    • DepartmentSettingsSchema
    • LoginRequest
    • ChangePatchDto
    • CustomFieldCategory
    • CustomFieldSchema
    • PaymentMethod
    • File
    • ChangeSubmitPatchRequest
    • RefreshRequest
    • MembershipSubmitResponse
    • CustomFieldType
    • RegisterRequest
    • FormCancellation
    • ProblemDetails
    • SubmitAcceptRequest
    • SubmitDenyRequest
    • FormMembership
    • ResendConfirmationEmailRequest
    • CustomDesignSettings
    • MembershipSchema
    • CustomFieldPatchDto
    • DataPrivacySchema
    • ResetPasswordRequest
    • ValidationProblemDetails
    • SubmitResponse
    • TwoFactorRequest
    • FamilyMemberPatchDto
    • StartExportJobRequest
    • TwoFactorResponse
    • SubmitState
    • EMailTemplateType
    • UpdateUserRequest
    • MembershipPatchDto
    • SubmitHistoryResponse
    • UserResponse
    • MembershipPatchRequest
    • SubmitHistoryType
    • UserRole
    • GetEmailTemplateResponse
    • FormDesign
    • SetEmailTemplateRequest
    • SmtpSettingsReadDto
    • SmtpSettingsWriteDto
    • SmtpTestResultDto
Handbuch
DeveloperVereinsantrag.online
Handbuch
DeveloperVereinsantrag.online
  1. Forms

Updates form Design

POST
https://api.vereinsantrag.de/v1/club/form-design
Updates the form design configuration for the club. It affects all form types.

Request

Query Params

Body Params application/json

Examples

Responses

🟱200
application/json
OK
Body

🟠400
Request Request Example
Shell
JavaScript
Java
Swift
curl --location --request POST 'https://api.vereinsantrag.de/v1/club/form-design?preview' \
--header 'Content-Type: application/json' \
--data-raw '{
    "presetDesign": "string",
    "customDesign": {
        "pageBackground": {
            "type": "string",
            "color": "string",
            "gradientStart": "string",
            "gradientEnd": "string",
            "gradientDegree": 0
        },
        "formBackground": {
            "type": "string",
            "color": "string",
            "gradientStart": "string",
            "gradientEnd": "string",
            "gradientDegree": 0
        },
        "topMargin": 0,
        "backgroundImageUrl": "string",
        "backgroundImageSettings": {
            "repeat": "string",
            "size": "string",
            "customWidth": 0,
            "customHeight": 0,
            "position": "string",
            "attachment": "string"
        },
        "textColor": "string",
        "hideLogo": true,
        "formWidth": "string",
        "formWidthCustom": 0,
        "borderRadius": 0,
        "boxShadow": "string"
    },
    "additionalCss": "string",
    "dateModified": "2019-08-24T14:15:22.123Z"
}'
Response Response Example
200 - Example 1
{
    "presetDesign": "string",
    "customDesign": {
        "pageBackground": {
            "type": "string",
            "color": "string",
            "gradientStart": "string",
            "gradientEnd": "string",
            "gradientDegree": 0
        },
        "formBackground": {
            "type": "string",
            "color": "string",
            "gradientStart": "string",
            "gradientEnd": "string",
            "gradientDegree": 0
        },
        "topMargin": 0,
        "backgroundImageUrl": "string",
        "backgroundImageSettings": {
            "repeat": "string",
            "size": "string",
            "customWidth": 0,
            "customHeight": 0,
            "position": "string",
            "attachment": "string"
        },
        "textColor": "string",
        "hideLogo": true,
        "formWidth": "string",
        "formWidthCustom": 0,
        "borderRadius": 0,
        "boxShadow": "string"
    },
    "additionalCss": "string",
    "dateModified": "2019-08-24T14:15:22.123Z"
}
Previous
Get Form Design
Next
Retrieves all memberships for the current club.
Built with