API Reference

Add embed widget settings

This API is used to insert the embed widget settings for the event and organizer page.

For the organizer page, only a calendar widget can be embedded into your website so people can pick an event date and register right from your site.

Path Parameters recurringEventId- Unique identifier of the event default value is 0. eventUrl

Body Parameters See RAW_BODY for more info.

Response This API success message is mentioned in the Ok message.

Authentication required - ✅

Role wise accessibility 
 Super Admin - ✅ Admin - ✅ Whitelabel Admin - ✅ Staff - ❌ Attendee - ❌ Exhibitor - ❌ Speaker - ❌

Modules Display - ❌ Portal - ❌ Host - ✅

Here are the possible error messages, which return if any conditions fail or the required data is missing for processing.

Error code

Error Description

4064901

The Organizer/Event id sends null in the payload.

4064903

The Embed widget setting already exists.

4064902

The Embed widget setting type does not exist.
This error will appear when the type parameter value passed is other than the existing options.

4060036

JSON Format is not valid.
This error will appear when the passed parameters' values are any of the below:

  • buyTicketsButton
  • calendar
  • countdown
  • donation
  • ticketingWidget
Language
Credentials
Header
Click Try It! to start a request and see the response here!