Skip to main content
POST
/
v2
/
user
/
{user_id}
/
create_portal_url
curl --request POST \
     --url {{BASE_URL}}/v2/user/{{USER_ID}}/create_portal_url \
     --header 'Accept: application/json' \
     --header 'x-vital-api-key: <API_KEY>' \
     --header 'Content-Type: application/json' \
     --data '{"context":"launch"}'

{
  "url": "<string>",
  "expires_in": 123
}

This feature is in closed beta.Interested in this feature? Get in touch with your Customer Success Manager.
Create a URL to Junction User Portal pre-authorized to a particular User. Junction User Portal requires demographics having been specified for the User:
If you attempt to create a Portal URL for a user without demographics, you will get a 422 Unprocessable Entity response.
Shortened Portal URL (context: communications) is not yet available. Attempts to create one would result in a 422 Unprocessable Entity response.
curl --request POST \
     --url {{BASE_URL}}/v2/user/{{USER_ID}}/create_portal_url \
     --header 'Accept: application/json' \
     --header 'x-vital-api-key: <API_KEY>' \
     --header 'Content-Type: application/json' \
     --data '{"context":"launch"}'

Authorizations

​
x-vital-api-key
string
header
required

Vital Team API Key

Path Parameters

​
user_id
string<uuid>
required

Body

application/json
​
context
enum<string>
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.

Available options:
launch,
communications
​
order_id
string<uuid> | null

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

Response

Successful Response

​
url
string
required
​
expires_in
integer
required
⌘I