Sign in

v1

latestOpenAPI 3.0.02026-07-24161215397.4 KB
Members

Manage member portal access

Manage portal access for a member. This endpoint enables or disables a member's ability to access the members portal.

Enabling Portal Access (isPortalAccessEnabled = true):

ScenarioBehavior
Member has no portal accessCreates or finds a user (by member email), creates the user role, and sends an invitation email
Member already has portal accessIf shouldSendInvitation is true, re-sends the invitation email; otherwise does nothing

Disabling Portal Access (isPortalAccessEnabled = false):

  • Deletes the user role that links the user to the member, revoking portal access

Request Properties:

  • isPortalAccessEnabled: Required. Set to true to grant or maintain access, false to revoke access
  • shouldSendInvitation: Optional (default: false). When true, re-sends an invitation email. Only applies when the member already has portal access

Required scopes: flex.community.members.portalAccess.update

put/api/v2/organizations/{orgSlug}/members/{memberId}/portal-access

Path parameters

memberIdstring required

member id

orgSlugstring required

organization slug

Request body

isPortalAccessEnabledboolean required

Determines whether the member has access to the members portal.

shouldSendInvitationboolean

Determines if an invitation email should be sent to the user. If not provided, defaults to false.

Example request

{
  "isPortalAccessEnabled": true,
  "shouldSendInvitation": true
}