Portals are public-facing websites that allow external users to interact with your Organization. Currently, each Portal can contain one BookingModule.
Portals have customizable authentication (public or password-protected) and are accessible via a URL pattern: https://portal.prosperoapp.com/{orgNamespace}/{slug}.
Create a Portal
Creates a new Portal based on the provided fields.
If a slug is not provided, a random string of six characters will be generated.
Request Body
orgIdstring · uuid · requiredThe id of the
Organizationthat owns thisPortal.namestring · requiredThe display name of the
Portal.statusinteger · enum · requiredThe publish status of the
Portal.Value Name Description 0 LIVE The Portalis publicly accessible1 DRAFT The Portalis in draft mode and not publicly accessibleEnum values:01authenticationrequiredAuthentication settings for the
Portal.
slugstringThe URL slug for this
Portal. If not provided, a random string of six characters will be generated. Used to create the public link with the patternhttps://portal.prosperoapp.com/{orgNamespace}/{slug}.
Responses
The newly created Portal.
portalobject · required
Update a Portal
Updates the specified Portal by setting the values of the fields passed. Any fields not provided will be left unchanged. By design, you cannot change a Portal's id.
path Parameters
portalIdstring · uuid · requiredThe id of the
Portal.
Request Body
namestringThe display name of the
Portal.slugstringThe URL slug for this
Portal. Used to create the public link with the patternhttps://portal.prosperoapp.com/{orgNamespace}/{slug}.statusinteger · enumThe publish status of the
Portal.Value Name Description 0 LIVE The Portalis publicly accessible1 DRAFT The Portalis in draft mode and not publicly accessibleEnum values:01authenticationAuthentication settings for the
Portal.
Responses
The updated Portal.
portalobject · required