---
title: "POST /v1/account/tenant"
method: POST
path: "/v1/account/tenant"
tags: ["account"]
---

# POST /v1/account/tenant

`POST /v1/account/tenant`

## Request

- Base URL: `https://api.thebridge.dev` (the document declares no server; this is the origin it was published from)
- URL: `https://api.thebridge.dev/v1/account/tenant`
- Auth: none declared

## Request body

- CreateTenantRequestDto
  - `plan` string: The plan must be present in the configured App business model
  - `priceOffer` PriceOffer
  - `owner` TenantOwnerRequestDto, required
    - `email` string, email, required: Required
    - `firstName` string: The first name
    - `lastName` string: The last name
    - `muteNotifications` boolean: Set this variable to true if you don't wish to send out any notifications to the new user
    - `customParams` CustomParam[]
      - `value` string, required
      - `label` string, required
      - `userLabel` string
      - `type` 'email' | 'phone' | 'number' | 'integer' | 'text' | 'regex' | 'boolean', required
      - `regex` string, required
  - `name` string: Name of the new tenant. Can also be set by tenant owner during onboarding
  - `onboarded` boolean: Is the tenant considered onboarded from start?
  - `logo` string: A url to a logo. Can also be set by tenant owner during onboarding
  - `locale` string: The default locale / lang code for all users in this tenant (`ISO_639-1` format). This property will set the i18n for all platform emails and can be used to. Defaults to 'en'
  - `metadata` object: Store metadata for your own business logic that will be returned in every Tenant response. This data will never be outputted to the end user
  - `authOriginUrl` string: Origin URL of the caller — used to resolve where email links (e.g. password reset) should point
  - `signupMethod` string: TBP-505 — how the tenant owner signed up (e.g. 'google', 'ms-azure-ad', 'linkedin'). Set ONLY by the federation signup path so account can fire the SignUp/Lead conversion tracking server-side — SSO signups never pass through the client-side signup page that fires them for email signups. Deliberately NOT in the import allowlist (TBP-43): imports must not fire conversion events.

## Response `201`

- TenantResponseDto
  - `id` string, required: Logical id reference to this instance
  - `plan` string: Name of the subscription plan. (Read only) Use `setPlanDetails` to change it Automatically set by the payment service if tenant used the checkout process
  - `mfa` boolean, required: MFA enabled
  - `paymentStatus` object, required: Payment status
  - `trial` boolean, required: Tenant is trialing (Read only)
  - `locale` string, required: The default locale / lang code for all users in this tenant (`ISO_639-1` format). This property will set the i18n for all platform emails and can be used to
  - `name` string: Name of the tenant. Undefined from the begining until the Tenant owner complets tenant onboarding.
  - `logo` string: Url to a public accessible logo
  - `metadata` object, required: Store app specific meta data for this tenant
  - `onboarded` boolean, required: If this tenant is considered onboarded
  - `federationConnection` string: Logins are made with this enterprise login connection
  - `signupBy` object
    - `email` string
    - `firstName` string
    - `lastName` string
  - `createdAt` string, date-time, required: Timestamp when created

---

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