TRtryvital
user

Create User Portal Url

post/v2/user/{user_id}/create_portal_url

Request

  • Base URL
    https://api.us.junction.com
  • URL
    https://api.us.junction.com/v2/user/{user_id}/create_portal_url
  • Auth
    API key in header x-vital-api-key

Path parameters

user_idstring uuid required

Request body

context'launch' | 'communications' required

launch: Generates a short-lived (minutes) portal URL that is intended for launching a user from your authenticated web context directly into the Junction User Portal. This URL is not suitable for asynchronous communications due to its verbosity as well as short-lived nature.

communications: Generates a long-lived (weeks) but shortened portal URL that is suitable for Emails, SMS messages and other communication channels. Users may be asked to verify their identity with Email and SMS authentication, e.g., when they open a short link on a new device. ℹ️ This enum is non-exhaustive.

order_idstring uuid nullable

If specified, the generated URL will deeplink to the specified Order.

Response

Successful Response

urlstring required
expires_ininteger required

Changes

No recorded changes to this operation across all 201 revisions of this API.