---
title: "Share client portal link"
method: POST
path: "/v1/cases/{id}/share-client-portal-link"
tags: ["Client portal"]
---

# Share client portal link

`POST /v1/cases/{id}/share-client-portal-link`

Generate an authenticated link to access a client portal for a business contact.

---

#### See also  
Learn more about [Cases](./cases-guide)

## Path parameters

- `id` string, uuid, required

## Request body

- ClientPortalShareLink
  - `client_portal_id` string, uuid, required
  - `business_contact_id` string, uuid — The business contact needs to exists in the case. If the individual is not yet business contact, it will be updated to be marked as such. If not specified, the case must have a business contact already and it will be used.

## Response `201`

**ℹ️ Click to see full payload**

- ClientPortalShareLinkResponse
  - `case_id` string, uuid, required
  - `client_portal_id` string, uuid, required
  - `business_contact` ClientPortalShareLinkResponseBusinessContact, required
    - `id` string, uuid, required
    - `first_name` string, required
    - `last_name` string, required
    - `email` string, email, required
  - `link` string, url, required — URL to the client portal authenticated for the business contact
  - `expires_at` string, date-time, required — Date time in format [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) (`yyyy-MM-ddTHH:mm:ss.S+X` eg `2023-01-31T13:30:00.000Z`)

## Other responses

- `400` — The request is either malformed or contain invalid parameters. - Make sure the identifier specified in the URL is a valid UUID - Make sure the body payload matches the expected schema - Make sure that the client portal is online - If `business_contact_id` is specified, the individual must belong to the case, be relevant, and have an email address. If not already a business contact, they will be marked as one - If `business_contact_id` is not specified, the case must have a business contact
- `404` — No case, client portal or business contact can be found.

---

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