Formular aktualisieren
Die Methode UpdateForm ermöglicht es, ein bestehendes Formular zu aktualisieren. Alle Eigenschaften, die nicht gesetzt sind, bleiben unverändert.
Request Properties
Form
Das Formular mit den zu ändernden Eigenschaften. UniqueId muss gesetzt sein und identifiziert das zu aktualisierende Formular.
Typ der Eigenschaft: Form
Folgende Eigenschaften des Formulars können aktualisiert werden: Name, Language, InternDescription, InactiveDate, InactiveText, RestrictAccessProfileId, Notify, SuccessFollowPageSettings und ErrorFollowPageSettings. Werden andere Eigenschaften gesetzt, wird ein Fehler zurückgegeben, der diese Eigenschaften benennt.
Die gesamte Aktualisierung erfolgt in einer Transaktion: Schlägt ein Teil fehl, wird keine der Änderungen übernommen.
Validierungen
- Der Name darf im Mandanten nicht bereits von einem anderen Formular desselben Typs verwendet werden.
- Die in Language angegebene Sprache muss im Mandanten verfügbar sein.
- Die Absenderadresse der Benachrichtigung muss in einer der freigegebenen Domains des Mandanten liegen, die Empfängeradressen müssen gültige E-Mail Adressen sein, und die Anzahl der Empfängernamen muss der Anzahl der Empfängeradressen entsprechen.
- Formulare vom Typ Event können nicht aktualisiert werden.
Sprachwechsel
Wird Language geändert, so werden die sprachabhängigen Einstellungen des Formulars zurückgesetzt: die Standardfelder werden umbenannt, die Landingpages der Erfolgs- und Fehlerseite, ein hinterlegtes Bestätigungsmailing sowie bestehende Sendepläne (E-Mail, SMS, WhatsApp) werden entfernt. Ist eine Folgeseite auf eine Landingpage eingestellt, so muss im selben Request über LandingPageId eine Landingpage der neuen Sprache angegeben oder über Type eine andere Art der Folgeseite gewählt werden, andernfalls wird ein Fehler zurückgegeben.
Beispiel Request „Formular aktualisieren“
Der folgende Request ändert den Namen und die interne Beschreibung des Formulars und hinterlegt neue Empfänger für die Benachrichtigung. Alle übrigen Eigenschaften des Formulars bleiben unverändert, ebenso die nicht angegebenen Eigenschaften der Benachrichtigung wie z.B. der Absender.
//https://mailworx.marketingsuite.info/Services/JSON/ServiceAgent.svc/UpdateForm
{
"request": {
"Language": "DE",
"SecurityContext": {
"Account": "account",
"Username": "username",
"Password": "****",
"Source": "application name"
},
"Form": {
"UniqueId": "4b5d9a1e-2c37-4f08-9a6b-71e3c5d2f840",
"Name": "Kontaktformular Messe 2026",
"InternDescription": "Formular für die Messe im Frühjahr",
"Notify": {
"SendNotify": true,
"RecipientNames": "Max Mustermann;Erika Musterfrau",
"RecipientAddresses": "[email protected];[email protected]"
},
"SuccessFollowPageSettings": {
"Type": 1,
"Headline": "Vielen Dank!",
"Text": "Wir melden uns in Kürze bei Ihnen."
}
}
}
}<soap:Envelope xmlns:soap="http://www.w3.org/2003/05/soap-envelope"
xmlns:ser="http://www.mailworx.at/interfaces/serviceagent/"
xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
<soap:Header/>
<soap:Body>
<ser:UpdateForm>
<ser:request>
<ser:Language>DE</ser:Language>
<ser:SecurityContext>
<ser:Account>account</ser:Account>
<ser:Username>username</ser:Username>
<ser:Password>*****</ser:Password>
<ser:Source>application name</ser:Source>
</ser:SecurityContext>
<ser:Form>
<ser:UniqueId>4b5d9a1e-2c37-4f08-9a6b-71e3c5d2f840</ser:UniqueId>
<ser:Name>Kontaktformular Messe 2026</ser:Name>
<ser:InternDescription>Formular für die Messe im Frühjahr</ser:InternDescription>
<ser:Notify>
<ser:SendNotify>true</ser:SendNotify>
<ser:RecipientNames>Max Mustermann;Erika Musterfrau</ser:RecipientNames>
<ser:RecipientAddresses>[email protected];[email protected]</ser:RecipientAddresses>
</ser:Notify>
<ser:SuccessFollowPageSettings>
<ser:Type>Text</ser:Type>
<ser:Headline>Vielen Dank!</ser:Headline>
<ser:Text>Wir melden uns in Kürze bei Ihnen.</ser:Text>
</ser:SuccessFollowPageSettings>
</ser:Form>
</ser:request>
</ser:UpdateForm>
</soap:Body>
</soap:Envelope>Response Objekt
Die Response enthält keine Eigenschaften. Wird kein Fehler zurückgegeben, so wurde das Formular erfolgreich aktualisiert.