> Portal Navigation: > > - Append `.md` to any URL under `https://dev.wix.com/docs/` to get its markdown version. > - Pages are either content pages (article or reference text) or menu pages (a list of links to child pages). > - To get a menu page, truncate any URL to a parent path and append `.md` (e.g. `https://dev.wix.com/docs/sdk.md`, `https://dev.wix.com/docs/sdk/core-modules.md`). > - Top-level index of all portals: https://dev.wix.com/docs/llms.txt > - Full concatenated docs: https://dev.wix.com/docs/llms-full.txt # CreateRsvp # Package: registration # Namespace: RsvpManagement # Method link: https://dev.wix.com/docs/api-reference/business-solutions/events/registration/rsvp-v2/create-rsvp.md ## Permission Scopes: Manage Events: SCOPE.EVENTS.MANAGE-EVENTS ## Introduction Creates an RSVP. To create anRSVP with multiple guests, you have to specify the `additionalGuests` and `guestNames` fields. --- ## REST API ### Schema ``` Method: createRsvp Description: Creates an RSVP. To create anRSVP with multiple guests, you have to specify the `additionalGuests` and `guestNames` fields. URL: https://www.wixapis.com/events/v2/rsvps Method: POST # Note: If the parameter `a.b` is listed under required parameters, `b` is only required if `a` is also present. Required parameters: rsvp.eventId, rsvp, rsvp.status, rsvp.firstName, rsvp.lastName, rsvp.email, rsvp.additionalGuestDetails.guestCount Method parameters: param name: fields | type: array | description: Predefined sets of fields to return. - enum: - DETAILS: Returns `createdDate`, `updatedDate`, `firstName`, `lastName`, `totalGuests`, `guests`. - FORM: Returns `form`. - CONTACT_DETAILS: Returns `email`. param name: options | type: ModificationOptions - name: ignoreLimits | type: boolean | description: Whether to create or update an RSVP regardless of the event's guest limit. - name: ignoreFormValidation | type: boolean | description: Whether to ignore the form validation. - name: ignoreResponseStatus | type: boolean | description: Whether to ignore the response status. - name: ignoreAdditionalGuestNames | type: boolean | description: Whether to ignore the additional guest names validation. param name: rsvp | type: Rsvp | required: true - name: eventId | type: string | description: Event GUID to which the RSVP belongs. | required: true - name: memberId | type: string | description: Site member GUID. - name: contactId | type: string | description: Contact GUID of a guest who filled in the RSVP form. See the Contacts API for more details. - name: firstName | type: string | description: First name of a guest who filled in the RSVP form. | required: true - name: lastName | type: string | description: Last name of a guest who filled in the RSVP form. | required: true - name: email | type: string | description: Email of a guest who filled in the RSVP form. | required: true - name: form | type: FormResponse | description: Event registration form. - name: inputValues | type: array | description: Form field inputs. - name: inputName | type: string | description: Form field input name. - name: value | type: string | description: Form field value. - name: values | type: array | description: Form field values. - name: status | type: RsvpStatus | description: RSVP response status. | required: true - enum: - YES: Guest is attending the event. - NO: Guest isn't attending the event. - WAITLIST: Guest is on a waitlist. - name: additionalGuestDetails | type: AdditionalGuestDetails | description: Additional guest details. - name: guestCount | type: integer | description: Number of additional guests. | required: true - name: guestNames | type: array | description: Names of additional guests. - name: disableNotifications | type: boolean | description: Whether notifications are disabled. - name: marketingConsent | type: boolean | description: Whether a guest agreed to marketing. - name: extendedFields | type: ExtendedFields | description: Custom field data for the RSVP object. **Note:** You must configure extended fields using schema plugin extensions in your app's dashboard before you can access the extended fields with API calls. - name: namespaces | type: object | description: Extended field data. Each key corresponds to the namespace of the app that created the extended fields. The value of each key is structured according to the schema defined when the extended fields were configured. You can only access fields for which you have the appropriate permissions. Learn more about [extended fields](https://dev.wix.com/docs/rest/articles/getting-started/extended-fields.md). Return type: CreateRsvpResponse - name: rsvp | type: Rsvp | description: Created RSVP. - name: id | type: string | description: GUID of the RSVP. - name: revision | type: string | description: Revision number, which increments by 1 each time the RSVP is updated. To prevent conflicting changes, the existing `revision` must be used when updating the RSVP. - name: eventId | type: string | description: Event GUID to which the RSVP belongs. - name: createdDate | type: string | description: Date and time the RSVP was created. - name: updatedDate | type: string | description: Date and time the RSVP was updated. - name: memberId | type: string | description: Site member GUID. - name: contactId | type: string | description: Contact GUID of a guest who filled in the RSVP form. See the Contacts API for more details. - name: firstName | type: string | description: First name of a guest who filled in the RSVP form. - name: lastName | type: string | description: Last name of a guest who filled in the RSVP form. - name: email | type: string | description: Email of a guest who filled in the RSVP form. - name: form | type: FormResponse | description: Event registration form. - name: inputValues | type: array | description: Form field inputs. - name: inputName | type: string | description: Form field input name. - name: value | type: string | description: Form field value. - name: values | type: array | description: Form field values. - name: status | type: RsvpStatus | description: RSVP response status. - enum: - YES: Guest is attending the event. - NO: Guest isn't attending the event. - WAITLIST: Guest is on a waitlist. - name: totalGuests | type: integer | description: Total number of guests per 1 RSVP. - name: guestList | type: GuestList | description: Guest list. - name: guests | type: array | description: List of guests. - name: index | type: integer | description: Index of each guest in the array. - name: fullName | type: string | description: Full name. - name: checkInDetails | type: CheckInDetails | description: Check-in details. - name: checkedIn | type: boolean | description: Whether the guest has checked in. - name: checkInDate | type: string | description: Date and time the guest checked in. - name: checkInCanceledDate | type: string | description: Date and time the guest cancelled check-in. - name: checkedInBy | type: string | description: Id of the user who last performed check-in - name: checkInCanceledBy | type: string | description: Id of the user who last canceled check-in - name: checkedInByStaffMember | type: string | description: Id of the Staff Member who last performed check-in - name: checkInCanceledByStaffMember | type: string | description: Id of theStaff Member who last canceled check-in - name: guestId | type: integer | description: Guest GUID. - name: language | type: string | description: 2-letter language code in the [ISO 639-1](https://en.wikipedia.org/wiki/List_of_ISO_639-1_codes) format. - name: locale | type: string | description: Locale in the [IETF BCP 47](https://en.wikipedia.org/wiki/IETF_language_tag) format. - name: fullyCheckedIn | type: boolean | description: Whether all guests are checked in. - name: checkedInGuestCount | type: integer | description: Number of checked in guests. - name: additionalGuestDetails | type: AdditionalGuestDetails | description: Additional guest details. - name: guestCount | type: integer | description: Number of additional guests. - name: guestNames | type: array | description: Names of additional guests. - name: disableNotifications | type: boolean | description: Whether notifications are disabled. - name: onlineConferencingLogin | type: OnlineConferencingLogin | description: Guest login details for accessing the online conference event. - name: link | type: string | description: Link URL to the online conference. - name: password | type: string | description: Password for the online conference. - name: anonymized | type: boolean | description: Whether an RSVP is anonymized. - name: marketingConsent | type: boolean | description: Whether a guest agreed to marketing. - name: extendedFields | type: ExtendedFields | description: Custom field data for the RSVP object. **Note:** You must configure extended fields using schema plugin extensions in your app's dashboard before you can access the extended fields with API calls. - name: namespaces | type: object | description: Extended field data. Each key corresponds to the namespace of the app that created the extended fields. The value of each key is structured according to the schema defined when the extended fields were configured. You can only access fields for which you have the appropriate permissions. Learn more about [extended fields](https://dev.wix.com/docs/rest/articles/getting-started/extended-fields.md). - name: calendarLinks | type: CalendarLinks | description: "Add to calendar" links. - name: google | type: string | description: "Add to Google calendar" URL. - name: ics | type: string | description: "Download ICS calendar file" URL. Possible Errors: HTTP Code: 400 | Status Code: INVALID_ARGUMENT | Application Code: ADDITIONAL_GUESTS_MUST_HAVE_NAMES | Description: Additional guests must have names when `guestCount` is greater than 0. HTTP Code: 400 | Status Code: INVALID_ARGUMENT | Application Code: UNEXPECTED_RSVP_STATUS | Description: RSVP status isn't valid for this operation. HTTP Code: 400 | Status Code: INVALID_ARGUMENT | Application Code: INVALID_FORM_RESPONSE | Description: Form response is invalid or doesn't match the event's form requirements. HTTP Code: 400 | Status Code: INVALID_ARGUMENT | Application Code: EVENT_NOT_FOUND | Description: Couldn't find the event. HTTP Code: 428 | Status Code: FAILED_PRECONDITION | Application Code: FORM_SUBMISSIONS_NOT_SUPPORTED | Description: none HTTP Code: 428 | Status Code: FAILED_PRECONDITION | Application Code: MEMBER_EMAIL_ALREADY_REGISTERED | Description: There is already an RSVP with this email address for this event. HTTP Code: 428 | Status Code: FAILED_PRECONDITION | Application Code: WAITING_LIST_UNAVAILABLE | Description: Waitlist isn't available for this event. HTTP Code: 428 | Status Code: FAILED_PRECONDITION | Application Code: RSVPS_NOT_STARTED | Description: RSVPs for this event haven't started yet. HTTP Code: 428 | Status Code: FAILED_PRECONDITION | Application Code: RSVPS_CLOSED | Description: RSVPs for this event are closed. HTTP Code: 428 | Status Code: FAILED_PRECONDITION | Application Code: GUEST_LIMIT_EXCEEDED | Description: Number of guests exceeds the event's guest limit. HTTP Code: 428 | Status Code: FAILED_PRECONDITION | Application Code: RSVP_LIMIT_EXCEEDED | Description: Event has reached its RSVP limit. HTTP Code: 428 | Status Code: FAILED_PRECONDITION | Application Code: MEMBER_ALREADY_REGISTERED | Description: Member already has an RSVP for this event. HTTP Code: 428 | Status Code: FAILED_PRECONDITION | Application Code: INVALID_EVENT_TYPE | Description: Event type doesn't support RSVPs. ``` ### Examples ### Create RSVP with multiple guests ```curl curl -X POST 'https://www.wixapis.com/events/v2/rsvps' \ -H 'Content-Type: application/json' \ -H 'Authorization: ' \ -d '{ "rsvp": { "eventId": "32c0eab1-b7a0-4ec2-9fb6-db76f76ee488", "form": { "inputValues": [ { "inputName": "firstName", "value": "John" }, { "inputName": "lastName", "value": "Doe" }, { "inputName": "email", "value": "johndoe@mail.com" }, { "inputName": "additionalGuests", "value": "2" }, { "inputName": "guestNames", "values": [ "Patsy McBride", "Randy Ramirez" ] } ] }, "status": "YES" } }' ``` ### Create RSVP with 1 guest ```curl curl -X POST 'https://www.wixapis.com/events/v2/rsvps' \ -H 'Content-Type: application/json' \ -H 'Authorization: ' \ -d '{ "rsvp": { "eventId": "32c0eab1-b7a0-4ec2-9fb6-db76f76ee488", "form": { "inputValues": [ { "inputName": "firstName", "value": "John" }, { "inputName": "lastName", "value": "Doe" }, { "inputName": "email", "value": "johndoe@mail.com" } ] }, "status": "YES" } }' ``` --- ## JavaScript SDK ### Schema ``` Method: wixClientAdmin.registration.RsvpManagement.createRsvp(rsvp, options) Description: Creates an RSVP. To create anRSVP with multiple guests, you have to specify the `additionalGuests` and `guestNames` fields. # Note: If the parameter `a.b` is listed under required parameters, `b` is only required if `a` is also present. Required parameters: rsvp.eventId, rsvp, rsvp.status, rsvp.firstName, rsvp.lastName, rsvp.email, rsvp.additionalGuestDetails.guestCount Method parameters: param name: options | type: CreateRsvpOptions none - name: options | type: ModificationOptions | description: RSVP options.
The **WIX_EVENTS.MANAGE_RSVP** permission is required. - name: ignoreLimits | type: boolean | description: Whether to create or update an RSVP regardless of the event's guest limit. - name: ignoreFormValidation | type: boolean | description: Whether to ignore the form validation. - name: ignoreResponseStatus | type: boolean | description: Whether to ignore the response status. - name: ignoreAdditionalGuestNames | type: boolean | description: Whether to ignore the additional guest names validation. - name: fields | type: array | description: Predefined sets of fields to return. - enum: - DETAILS: Returns `createdDate`, `updatedDate`, `firstName`, `lastName`, `totalGuests`, `guests`. - FORM: Returns `form`. - CONTACT_DETAILS: Returns `email`. param name: rsvp | type: Rsvp | required: true - name: eventId | type: string | description: Event GUID to which the RSVP belongs. | required: true - name: memberId | type: string | description: Site member GUID. - name: contactId | type: string | description: Contact GUID of a guest who filled in the RSVP form. See the Contacts API for more details. - name: firstName | type: string | description: First name of a guest who filled in the RSVP form. | required: true - name: lastName | type: string | description: Last name of a guest who filled in the RSVP form. | required: true - name: email | type: string | description: Email of a guest who filled in the RSVP form. | required: true - name: form | type: FormResponse | description: Event registration form. - name: inputValues | type: array | description: Form field inputs. - name: inputName | type: string | description: Form field input name. - name: value | type: string | description: Form field value. - name: values | type: array | description: Form field values. - name: status | type: RsvpStatus | description: RSVP response status. | required: true - enum: - YES: Guest is attending the event. - NO: Guest isn't attending the event. - WAITLIST: Guest is on a waitlist. - name: additionalGuestDetails | type: AdditionalGuestDetails | description: Additional guest details. - name: guestCount | type: integer | description: Number of additional guests. | required: true - name: guestNames | type: array | description: Names of additional guests. - name: disableNotifications | type: boolean | description: Whether notifications are disabled. - name: marketingConsent | type: boolean | description: Whether a guest agreed to marketing. - name: extendedFields | type: ExtendedFields | description: Custom field data for the RSVP object. **Note:** You must configure extended fields using schema plugin extensions in your app's dashboard before you can access the extended fields with API calls. - name: namespaces | type: object | description: Extended field data. Each key corresponds to the namespace of the app that created the extended fields. The value of each key is structured according to the schema defined when the extended fields were configured. You can only access fields for which you have the appropriate permissions. Learn more about [extended fields](https://dev.wix.com/docs/rest/articles/getting-started/extended-fields.md). Return type: PROMISE - name: _id | type: string | description: GUID of the RSVP. - name: revision | type: string | description: Revision number, which increments by 1 each time the RSVP is updated. To prevent conflicting changes, the existing `revision` must be used when updating the RSVP. - name: eventId | type: string | description: Event GUID to which the RSVP belongs. - name: _createdDate | type: Date | description: Date and time the RSVP was created. - name: _updatedDate | type: Date | description: Date and time the RSVP was updated. - name: memberId | type: string | description: Site member GUID. - name: contactId | type: string | description: Contact GUID of a guest who filled in the RSVP form. See the Contacts API for more details. - name: firstName | type: string | description: First name of a guest who filled in the RSVP form. - name: lastName | type: string | description: Last name of a guest who filled in the RSVP form. - name: email | type: string | description: Email of a guest who filled in the RSVP form. - name: form | type: FormResponse | description: Event registration form. - name: inputValues | type: array | description: Form field inputs. - name: inputName | type: string | description: Form field input name. - name: value | type: string | description: Form field value. - name: values | type: array | description: Form field values. - name: status | type: RsvpStatus | description: RSVP response status. - enum: - YES: Guest is attending the event. - NO: Guest isn't attending the event. - WAITLIST: Guest is on a waitlist. - name: totalGuests | type: integer | description: Total number of guests per 1 RSVP. - name: guestList | type: GuestList | description: Guest list. - name: guests | type: array | description: List of guests. - name: index | type: integer | description: Index of each guest in the array. - name: fullName | type: string | description: Full name. - name: checkInDetails | type: CheckInDetails | description: Check-in details. - name: checkedIn | type: boolean | description: Whether the guest has checked in. - name: checkInDate | type: Date | description: Date and time the guest checked in. - name: checkInCanceledDate | type: Date | description: Date and time the guest cancelled check-in. - name: checkedInBy | type: string | description: Id of the user who last performed check-in - name: checkInCanceledBy | type: string | description: Id of the user who last canceled check-in - name: checkedInByStaffMember | type: string | description: Id of the Staff Member who last performed check-in - name: checkInCanceledByStaffMember | type: string | description: Id of theStaff Member who last canceled check-in - name: guestId | type: integer | description: Guest GUID. - name: language | type: string | description: 2-letter language code in the [ISO 639-1](https://en.wikipedia.org/wiki/List_of_ISO_639-1_codes) format. - name: locale | type: string | description: Locale in the [IETF BCP 47](https://en.wikipedia.org/wiki/IETF_language_tag) format. - name: fullyCheckedIn | type: boolean | description: Whether all guests are checked in. - name: checkedInGuestCount | type: integer | description: Number of checked in guests. - name: additionalGuestDetails | type: AdditionalGuestDetails | description: Additional guest details. - name: guestCount | type: integer | description: Number of additional guests. - name: guestNames | type: array | description: Names of additional guests. - name: disableNotifications | type: boolean | description: Whether notifications are disabled. - name: onlineConferencingLogin | type: OnlineConferencingLogin | description: Guest login details for accessing the online conference event. - name: link | type: string | description: Link URL to the online conference. - name: password | type: string | description: Password for the online conference. - name: anonymized | type: boolean | description: Whether an RSVP is anonymized. - name: marketingConsent | type: boolean | description: Whether a guest agreed to marketing. - name: extendedFields | type: ExtendedFields | description: Custom field data for the RSVP object. **Note:** You must configure extended fields using schema plugin extensions in your app's dashboard before you can access the extended fields with API calls. - name: namespaces | type: object | description: Extended field data. Each key corresponds to the namespace of the app that created the extended fields. The value of each key is structured according to the schema defined when the extended fields were configured. You can only access fields for which you have the appropriate permissions. Learn more about [extended fields](https://dev.wix.com/docs/rest/articles/getting-started/extended-fields.md). Possible Errors: HTTP Code: 400 | Status Code: INVALID_ARGUMENT | Application Code: ADDITIONAL_GUESTS_MUST_HAVE_NAMES | Description: Additional guests must have names when `guestCount` is greater than 0. HTTP Code: 400 | Status Code: INVALID_ARGUMENT | Application Code: UNEXPECTED_RSVP_STATUS | Description: RSVP status isn't valid for this operation. HTTP Code: 400 | Status Code: INVALID_ARGUMENT | Application Code: INVALID_FORM_RESPONSE | Description: Form response is invalid or doesn't match the event's form requirements. HTTP Code: 400 | Status Code: INVALID_ARGUMENT | Application Code: EVENT_NOT_FOUND | Description: Couldn't find the event. HTTP Code: 428 | Status Code: FAILED_PRECONDITION | Application Code: FORM_SUBMISSIONS_NOT_SUPPORTED | Description: none HTTP Code: 428 | Status Code: FAILED_PRECONDITION | Application Code: MEMBER_EMAIL_ALREADY_REGISTERED | Description: There is already an RSVP with this email address for this event. HTTP Code: 428 | Status Code: FAILED_PRECONDITION | Application Code: WAITING_LIST_UNAVAILABLE | Description: Waitlist isn't available for this event. HTTP Code: 428 | Status Code: FAILED_PRECONDITION | Application Code: RSVPS_NOT_STARTED | Description: RSVPs for this event haven't started yet. HTTP Code: 428 | Status Code: FAILED_PRECONDITION | Application Code: RSVPS_CLOSED | Description: RSVPs for this event are closed. HTTP Code: 428 | Status Code: FAILED_PRECONDITION | Application Code: GUEST_LIMIT_EXCEEDED | Description: Number of guests exceeds the event's guest limit. HTTP Code: 428 | Status Code: FAILED_PRECONDITION | Application Code: RSVP_LIMIT_EXCEEDED | Description: Event has reached its RSVP limit. HTTP Code: 428 | Status Code: FAILED_PRECONDITION | Application Code: MEMBER_ALREADY_REGISTERED | Description: Member already has an RSVP for this event. HTTP Code: 428 | Status Code: FAILED_PRECONDITION | Application Code: INVALID_EVENT_TYPE | Description: Event type doesn't support RSVPs. ``` ### Examples ### Create RSVP with 1 guest ```javascript import { rsvpV2 } from "@wix/events"; const rsvp = { eventId: "32c0eab1-b7a0-4ec2-9fb6-db76f76ee488", form: { inputValues: [ { inputName: "firstName", value: "John" }, { inputName: "lastName", value: "Doe" }, { inputName: "email", value: "johndoe@mail.com" }, ], }, status: "YES" as const, }; async function createRsvp() { const response = await rsvpV2.createRsvp({ rsvp }); return response; } ``` ### createRsvp (self-hosted) Self-hosted SDK calls require you to [create a client](https://dev.wix.com/docs/sdk/articles/work-with-the-sdk/about-the-wix-client.md). ```javascript import { createClient } from '@wix/sdk'; import { rsvpV2 } from '@wix/events'; // Import the auth strategy for the relevant access type // Import the relevant host module if needed const myWixClient = createClient ({ modules: { rsvpV2 }, // Include the auth strategy and host as relevant }); async function createRsvp(rsvp,options) { const response = await myWixClient.rsvpV2.createRsvp(rsvp,options); }; ``` ---