---
title: "Choose a chat platform to connect"
method: POST
path: "/v1/onboarding-chat-platform"
tags: ["onboarding"]
---

# Choose a chat platform to connect

`POST /v1/onboarding-chat-platform`

## Request

- Base URL: `https://api.patricia.app` (the document declares no server; this is the origin it was published from)
- URL: `https://api.patricia.app/v1/onboarding-chat-platform`
- Auth: HTTP bearer

Record which chat platform a password-signup workspace wants to connect. A pick may be overwritten by a later one; refused only once the workspace has already installed a chat platform. Requires `tenant:read`.

## Headers

- `X-Tenant-Id` string, nullable

## Request body

- OnboardingChatPlatformRequest: A password-signup workspace's pick, for ``POST /v1/onboarding-chat-platform``.
  - `platform` 'slack' | 'microsoft_teams', required

## Response `200`

Successful Response

- OnboardingChatPlatformResponse
  - `platform` 'slack' | 'microsoft_teams', required

## Other responses

- `400`: Bad request
- `401`: Unauthorized
- `403`: Forbidden. Inspect response body `code` for the specific reason (for example: PERMISSION_DENIED, EMAIL_NOT_VERIFIED, TENANT_ACCESS_REQUIRED, ROLE_UNRESOLVED)
- `404`: Not found
- `409`: Conflict
- `422`: Validation error

---

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