POST api/memberaccessurls

Create a custom member share experience or securely embed the Member Portal or Share Widget in your app. This endpoint returns a Member's unique share links and access links for their portal or share widget. Exactly one search parameter is required: memberId, referralCode, emaillAddress or externalId.

Request Information

URI Parameters

Query String:

None.

Body Parameters

Structure used to represent a member access query. Required.

Type: MemberAccessUrlsQuery

Name	Description	Type	Additional information
memberId	Find a member by their internal ID	string	String length: inclusive between 36 and 36
referralCode	Find a member by their referral code	string	String length: inclusive between 0 and 50
emailAddress	Find a member by their email address	string	String length: inclusive between 0 and 100
externalId	Find a member by their external ID	string	String length: inclusive between 0 and 100
expireInMinutes	Number of minutes for the expiration of the member access Urls. Default 20 min. Optional.	integer	Range: inclusive between 5 and 43200

Request Formats

application/json, text/json

Sample:

{
  "memberId": "sample string 1",
  "referralCode": "sample string 2",
  "emailAddress": "sample string 3",
  "externalId": "sample string 4",
  "expireInMinutes": 1
}

application/xml, text/xml

Sample:

<memberAccessUrlsQuery xmlns:i="http://www.w3.org/2001/XMLSchema-instance">
  <emailAddress>sample string 3</emailAddress>
  <expireInMinutes>1</expireInMinutes>
  <externalId>sample string 4</externalId>
  <memberId>sample string 1</memberId>
  <referralCode>sample string 2</referralCode>
</memberAccessUrlsQuery>

Response Information

Resource Description

[HTTP Status 200 - OK]

Type: MemberAccessUrls

Name	Description	Type	Additional information
shareEmbedUrl	The pre-authenticated Share Embed URL for this member that only displays the selected share widget for the program so you can embed the share into your own portal or mobile app.	string	None.
fullEmbedUrl	The pre-authenticated Full Embed URL for this member for the portal experience that is meant to be embedded in your own portal or mobile app. The member will see the dashboard, share widget, portal menus, but no account management or logout.	string	None.
referralCode	The member's referral code.	string	None.
shareUrl	The member's personal share URL.	string	None.
smsShareUrl	The member text message share URL.	string	None.
whatsAppShareUrl	The member Whats App share URL.	string	None.
facebookShareUrl	The member Facebook share URL.	string	None.
facebookMessengerShareUrl	The member Facebook messenger share URL.	string	None.
twitterShareUrl	The member Twitter share URL.	string	None.
linkedInShareUrl	The member LinkedIn share URL.	string	None.
pinterestShareUrl	The member Pinterest URL.	string	None.
emailShareUrl	The member email share URL using mailto:, on mobile this requires a users gesture to support share tracking, the link will lead to a page with a share button..	string	None.
gmailShareUrl	The member Gmail webmail share URL, on mobile this requires a users gesture to support share tracking, the link will lead to a page with a share button..	string	None.
yahooShareUrl	The member Yahoo webmail share URL, on mobile this requires a users gesture to support share tracking, the link will lead to a page with a share button..	string	None.
outlookShareUrl	The member Outlook webmail share URL, on mobile this requires a users gesture to support share tracking, the link will lead to a page with a share button..	string	None.
aolShareUrl	The member AOL webmail share URL, on mobile this requires a users gesture to support share tracking, the link will lead to a page with a share button..	string	None.
telegramShareUrl	The member Telegram share URL.	string	None.
webShareUrl	The member Web Share API share URL. This requires a users gesture, the link will lead to a page with a share button.	string	None.
portalUrl	The pre-authenticated Portal URL for this member for the full browser experience where the member will see the full portal experience including the top section of the portal with the logo and additional navigation menus.	string	None.

Response Formats

application/json, text/json

Sample:

{
  "shareEmbedUrl": "sample string 1",
  "fullEmbedUrl": "sample string 2",
  "referralCode": "sample string 3",
  "shareUrl": "sample string 4",
  "smsShareUrl": "sample string 5",
  "whatsAppShareUrl": "sample string 6",
  "facebookShareUrl ": "sample string 7",
  "facebookMessengerShareUrl": "sample string 8",
  "twitterShareUrl": "sample string 9",
  "linkedInShareUrl": "sample string 10",
  "pinterestShareUrl": "sample string 11",
  "emailShareUrl": "sample string 12",
  "gmailShareUrl": "sample string 13",
  "yahooShareUrl": "sample string 14",
  "outlookShareUrl": "sample string 15",
  "aolShareUrl": "sample string 16",
  "telegramShareUrl ": "sample string 17",
  "webShareUrl": "sample string 18",
  "portalUrl": "sample string 19"
}

application/xml, text/xml

Sample:

<memberAccessUrls xmlns:i="http://www.w3.org/2001/XMLSchema-instance">
  <shareEmbedUrl>sample string 1</shareEmbedUrl>
  <fullEmbedUrl>sample string 2</fullEmbedUrl>
  <referralCode>sample string 3</referralCode>
  <shareUrl>sample string 4</shareUrl>
  <smsShareUrl>sample string 5</smsShareUrl>
  <whatsAppShareUrl>sample string 6</whatsAppShareUrl>
  <facebookShareUrl_x0020_>sample string 7</facebookShareUrl_x0020_>
  <facebookMessengerShareUrl>sample string 8</facebookMessengerShareUrl>
  <twitterShareUrl>sample string 9</twitterShareUrl>
  <linkedInShareUrl>sample string 10</linkedInShareUrl>
  <pinterestShareUrl>sample string 11</pinterestShareUrl>
  <emailShareUrl>sample string 12</emailShareUrl>
  <gmailShareUrl>sample string 13</gmailShareUrl>
  <yahooShareUrl>sample string 14</yahooShareUrl>
  <outlookShareUrl>sample string 15</outlookShareUrl>
  <aolShareUrl>sample string 16</aolShareUrl>
  <telegramShareUrl_x0020_>sample string 17</telegramShareUrl_x0020_>
  <webShareUrl>sample string 18</webShareUrl>
  <portalUrl>sample string 19</portalUrl>
</memberAccessUrls>