The Open API specification for Synapse is now available for download!

Download Open API Spec

POST /membershipInvitation

Create a membership invitation and send an email notification to the invitee. The team must be specified. Also, either an inviteeId or an inviteeEmail must be specified. Optionally, the creator may include an invitation message and/or expiration date for the invitation. If no expiration date is specified then the invitation never expires.

Note: The client must be an administrator of the specified Team to make this request.

Resource URL

https://repo-prod.prod.sagebase.org/repo/v1/membershipInvitation

Parameters
acceptInvitationEndpoint

optional

The portal endpoint prefix for one-click acceptance of the membership invitation. A signed, serialized token is appended to create the complete URL: JoinTeamSignedToken if an inviteeId is specified, or MembershipInvtnSignedToken if an inviteeEmail is specified. In normal operation, this parameter should be omitted.
notificationUnsubscribeEndpoint

optional

The portal endpoint prefix for one-click email unsubscription. A signed, serialized token is appended to create the complete URL: NotificationSettingsSignedToken. In normal operation, this parameter should be omitted.
Resource Information
Authentication Required
Required OAuth Scopes view , modify
HTTP Method POST
Request Object MembershipInvitation
(application/json)
Response Object MembershipInvitation
(application/json)