API Reference

Change the event plan

This API is used to change the plan of an event.
This will only allow changing to available plans.
This will also update the plan name to the intercome for the company.
This will also update the AE fee percentage and AE fee configuration as per the associated plan.
The system will only allow changing the plan if the event is not published yet.
This feature is not applicable for in-person events.

Path Parameters
organizerId- Unique identifier of an organizer.
eventId - Unique identifier of an event.
objectType- This parameter value can be PLAN or CHARGE. For Starter and Professional plan, objectType should be CHARGE for others it should be PLAN.
id- This parameter value can be plan id for object type Plan and charge id for object Type Charge.

Body Parameters
Not Required

Response
Details / Check response object

Authentication required - ✅

Role wise accessibility 

Super Admin - ✅
Admin - ✅
Staff - ❌
Attendee - ❌
Exhibitor - ❌
Speaker - ❌

Modules
Display - ❌
Portal - ❌
Host - ✅

Here are the possible error messages, which will return if any condition fails or if the required data is missing for processing.

Error codeError description
4010101This will appear when the user is not authorized to access this API.
4040200This will appear when the passed event id is not found.
4044104This will appear when the passed plan id is not found.
4040600This will appear when the passed organizer id is not found.
4060123This will appear if a starter or professional plan is associated but a starter or professional plan has not been purchased yet.
4060131This will appear when the passed event id is for an in-person event.
4060127This will appear when the passed event id is for an already published event.
4060536This will appear when it's changed to a Legacy Plan after 2021. This error will occur because, after 2021, Legacy Plan is no longer supported.

Get the virtual event settings and virtual event portal.
Language
Credentials
Header
Click Try It! to start a request and see the response here!