PATCH

Update Messages


Updates draft form messages, as displayed in the Wix UI before, during, and after the registration flow. Configurable messages include form titles, response labels, "thank you" messages, and call-to-action texts.

Authentication

You can only call this method when authenticated as a Wix app or Wix user identity.

Permissions
Manage Events - all permissions
Manage Events
Manage Events
Learn more about app permissions.
Endpoint
PATCH
https://www.wixapis.com/events/v1/events/{eventId}/form/messages

Path Params
eventIdstringRequired

Event ID.

Body Params
fieldsFieldsRequired

Set of field paths, specifying which parts of this resource to update. When fields are empty, request is interpreted as full update. Behavior follows google.protobuf.FieldMask semantics.


messagesMessages

Set of configured form messages.

Response Object
formForm

Modified draft event form.

Update Messages Example 1
Request
cURL
curl -X PATCH 'https://www.wixapis.com/events/v1/events/ad18d12e-a6a9-4c17-abfa-6ff119479be2/form/messages' \ -H 'Content-Type: application/json' \ -H 'Authorization: <AUTH TOKEN>' \ -d @- << EOF { "messages": { "rsvp": { "rsvpYesOption": "I will attend", "positiveMessages": { "confirmation": { "title": "Thank you!" } } }, "checkout": { "submitActionLabel": "Proceed" }, "registrationClosed": { "message": "Check our news page for updates." } }, "fields": { "paths": [ "messages.rsvp.rsvpYesOption", "messages.rsvp.positiveMessages.confirmation.title", "messages.checkout.submitActionLabel", "messages.registrationClosed.message" ] } } EOF
Response
JSON
{ "form": { "controls": [ { "type": "NAME", "system": true, "name": "name", "inputs": [ { "name": "firstName", "array": false, "label": "First Name", "additionalLabels": {}, "options": [], "mandatory": true, "maxLength": 50, "type": "TEXT" }, { "name": "lastName", "array": false, "label": "Last Name", "additionalLabels": {}, "options": [], "mandatory": true, "maxLength": 50, "type": "TEXT" } ], "label": "First Name, Last Name", "orderIndex": 0, "id": "name" }, { "type": "INPUT", "system": true, "name": "email", "inputs": [ { "name": "email", "array": false, "label": "Email", "additionalLabels": {}, "options": [], "mandatory": true, "maxLength": 50, "type": "TEXT" } ], "label": "Email", "orderIndex": 1, "id": "email" }, { "type": "INPUT", "system": false, "name": "phone-1a4acde6c958ff66", "inputs": [ { "name": "phone-1a4acde6c958ff66", "array": false, "label": "Work phone (line)", "additionalLabels": {}, "options": [], "mandatory": false, "maxLength": 25, "type": "TEXT" } ], "label": "Work phone (line)", "orderIndex": 2, "id": "phone-1a4acde6c958ff66" } ], "messages": { "rsvp": { "rsvpYesOption": "I will attend", "rsvpNoOption": "Not Going", "positiveMessages": { "title": "Add Your Details", "confirmation": { "title": "Thank you!", "message": "An email with all the event info was sent to you.", "addToCalendarActionLabel": "Add to Calendar", "shareActionLabel": "Share" } }, "waitlistMessages": { "title": "Looks Like This Event Is Full. Join the waiting list", "confirmation": { "title": "Thanks! You've been added to the waitlist.", "message": "We'll update you if additional spots become available.", "addToCalendarActionLabel": "Add to Calendar", "shareActionLabel": "Share" } }, "negativeMessages": { "title": "Add Your Details", "confirmation": { "title": "Sorry You Can't Make It", "shareActionLabel": "Share" } }, "submitActionLabel": "SUBMIT" }, "checkout": { "title": "Add Your Details", "submitActionLabel": "Proceed" }, "registrationClosed": { "message": "Check our news page for updates.", "exploreEventsActionLabel": "See other events" } } } }
Errors

This method doesn’t return any custom errors, but may return standard errors. Learn more about standard Wix errors.

Did this help?