---
title: "Create portal session"
method: POST
path: "/api/v1/apps/{appId}/recipients/{recipient}/portal-sessions"
tags: ["Recipients"]
---

# Create portal session

`POST /api/v1/apps/{appId}/recipients/{recipient}/portal-sessions`

## Request

- Base URL: `https://api-docs.relin.app`
- URL: `https://api-docs.relin.app/api/v1/apps/{appId}/recipients/{recipient}/portal-sessions`
- Auth: HTTP bearer

Create a short-lived customer portal URL.

## Path parameters

- `appId` string, required
- `recipient` string, required

## Request body

- object
  - `name` string
  - `capabilities` string[]
  - `theme` object
  - `returnUrl` string, uri
  - `expiresInSeconds` integer

## Response `200`

JSON response

- object
  - `portalSession` unknown

## Other responses

- `201`: JSON response
- `202`: JSON response
- `400`: Error response
- `401`: Error response
- `403`: Error response
- `404`: Error response

---

[API](https://skmtc.dev/relin/apis/relin-api.md) · [All operations](https://skmtc.dev/relin/apis/relin-api/llms.txt) · [OpenAPI document](https://skmtc.dev/relin/apis/relin-api/revisions/a845a07c47dd?raw)