---
title: "Create User Portal Url"
method: POST
path: "/v2/user/{user_id}/create_portal_url"
tags: ["user"]
---

# Create User Portal Url

`POST /v2/user/{user_id}/create_portal_url`

## Path parameters

- `user_id` string, uuid, required

## Request body

- CreateUserPortalURLBody
  - `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_id` string, uuid, nullable — If specified, the generated URL will deeplink to the specified Order.

## Response `200`

Successful Response

- CreateUserPortalURLResponse
  - `url` string, required
  - `expires_in` integer, required

## Other responses

- `422` — Validation Error

---

[API](https://skmtc.dev/tryvital/apis/junction-api.md) · [All operations](https://skmtc.dev/tryvital/apis/junction-api/llms.txt) · [OpenAPI document](https://skmtc-service-production.skmtc.workers.dev/v1/apis/tryvital/junction-api/revisions/e2454014f31e/schema)
