Invite Member/Signup

For B2B and team-based products, this endpoint is used to send an invitation email for a user to join a team (create a membership).

For B2C products, this endpoint is used to authorize a product to create a user-product membership on behalf of the user. The route will return a token which needs to be passed into the product's membership creation route: POST /p/memberships to create the membership.

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…

🚧

Required Admin Privileges

Inviting members require administrator priviliges on a team.

Body Params
string

[B2C] Unique product ID

string

[B2B] Unique team ID

string

[B2B] Email address of new team member to invite

string
Defaults to member

[B2B] User membership access level within team - one of: member or admin

scopes
array of strings

[B2B] List of membership scopes to set for this user on the team.

scopes
string

[B2B] Where to redirect the user when they accept the invite.

Headers
string
enum
Defaults to application/json

Generated from available response content types

Allowed:
Responses

Language
Credentials
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json