---
title: "Send Onboarding Email"
method: POST
path: "/entity/{entityId}/onboarding"
tags: ["entity"]
---

# Send Onboarding Email

`POST /entity/{entityId}/onboarding`

## Request

- Base URL: `https://api.mercoa.com`
- URL: `https://api.mercoa.com/entity/{entityId}/onboarding`
- Auth: HTTP bearer

Send an email with a onboarding link to the entity. The email will be sent to the email address associated with the entity.

## Path parameters

- `entityId` string, required

## Query parameters

- `type` 'PAYEE' | 'PAYOR', required
- `expiresIn` string
- `connectedEntityId` string
- `redirectToPortal` boolean
- `vendorPortalOptions` EntityTypesVendorPortalOptions
  - `tabs` EntityTypesVendorPortalTab[]: The tabs to display in the vendor portal. If not provided, all tabs will be displayed.
  - `defaultTab` 'HOME' | 'PROFILE' | 'INVOICES' | 'PAYMENT_METHODS' | 'VENDOR_CREDITS'
  - `welcomeMessage` string: The welcome message to display in the vendor portal. If not provided, no welcome message will be displayed.

## Response `200`

Successful response

## Other responses

- `400`: Error response with status 400
- `401`: Error response with status 401
- `403`: Error response with status 403
- `404`: Error response with status 404
- `409`: Error response with status 409
- `500`: Error response with status 500
- `501`: Error response with status 501

---

[API](https://skmtc.dev/mercoa/apis/mercoa-2.md) - [All operations](https://skmtc.dev/mercoa/apis/mercoa-2/llms.txt) - [OpenAPI document](https://skmtc.dev/mercoa/apis/mercoa-2/revisions/00a8e403ae18?raw)