Vereinsantrag
HandbuchDeveloperVereinsantrag.online
HandbuchDeveloperVereinsantrag.online
  1. Cancellations
  • Welcome to the developer portal
  • Get your token
  • Rate-Limiting
  • API-Reference
    • Authentication
      • AuthenticationService
        • Get token
        • Refresh token
        • Get account info
        • Change account 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
        • 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.
        • 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
          GET
        • Delete cancellation
          DELETE
        • Update cancellation submission
          PATCH
        • Create new cancellation
          POST
        • Get cancellation PDF
          GET
        • Get cancellation CSV
          GET
        • Export cancellation as text
          GET
        • Confirm cancellation
          POST
        • Resends the confirmation email for a cancellation application
          POST
        • Retrieves the history for a specific cancellation submission.
          GET
      • 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
  1. Cancellations

Update cancellation submission

PATCH
https://api.vereinsantrag.de/v1/submits/cancellations/{id}
Updates exactly ONE property of a cancellation submission. Supports updating personal data, cancellation details, and family members.

Request

Path Params

Body Params application/json

Examples

Responses

🟢204No Content
No Content
This response does not have a body.
🟠400Bad Request
🟠404Not Found
🔴500Internal Server Error
Request Request Example
Shell
JavaScript
Java
Swift
curl --location --request PATCH 'https://api.vereinsantrag.de/v1/submits/cancellations/' \
--header 'Content-Type: application/json' \
--data-raw '{
    "changeReason": "string",
    "cancellation": {
        "eMail": "user@example.com",
        "firstname": "string",
        "lastname": "string",
        "gender": "Woman",
        "birthday": "2019-08-24",
        "city": "string",
        "familyMember": {
            "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
            "firstname": "string",
            "lastname": "string",
            "gender": "Woman",
            "birthday": "2019-08-24"
        }
    }
}'
Response Response Example
400 - Example 1
{
    "type": "string",
    "title": "string",
    "status": 0,
    "detail": "string",
    "instance": "string",
    "property1": null,
    "property2": null
}
Previous
Delete cancellation
Next
Create new cancellation
Built with