---
title: "Send the welcome email to users"
method: POST
path: "/api/v1/users/welcome-email"
tags: ["Users"]
---

# Send the welcome email to users

`POST /api/v1/users/welcome-email`

## Request

- Base URL: `https://partner-api.monta.com`
- URL: `https://partner-api.monta.com/api/v1/users/welcome-email`
- Auth: HTTP bearer

Sends the welcome email to up to 100 of your users, so you can choose when they receive it. Each user is processed independently and gets its own result. A user who already got the welcome email is `skipped`, so a repeated or retried call never sends it twice; set `force` to send it again. Users that are not yours or have no email fail without affecting the others. Required scope: `users:write` </br>Organization authorization: `supported`

## Request body

- SendWelcomeEmail
  - `items` SendWelcomeEmailItem[], required: Users to send the welcome email to (between 1 and 100, no duplicates)
    - `userId` integer, required: Id of the user to send the welcome email to
  - `force` boolean: Send again to users who already got the welcome email. By default they are skipped, so repeating a call is safe

## Response `200`

Result per requested user

- SendWelcomeEmailResult
  - `data` WelcomeEmailItemResult[], required: One result per requested user, in request order
    - `userId` integer: Id of the requested user
    - `status` 'sent' | 'skipped' | 'failed', required
    - `error` string, nullable: Why the email was not sent, null when sent. `USER_NOT_FOUND`: the user does not exist or is not one of your users. `USER_HAS_NO_EMAIL`: the user has no email address. `ALREADY_SENT`: the user already got the welcome email. `UNEXPECTED_ERROR`: the email could not be queued, retry later
  - `meta` WelcomeEmailCounts, required
    - `successCount` integer: Number of users the welcome email was sent to
    - `skippedCount` integer: Number of users skipped because they already got the welcome email
    - `failureCount` integer: Number of users the welcome email could not be sent to

## Other responses

- `400`: `items` is missing, empty or has more than 100 users
- `401`: Consumer with provided credentials was not found
- `403`: Operator doesn't have access to resource
- `404`: Entity with the provided id was not found
- `422`: `items` repeats a user

## Changes

- **2026-11-03** `0ca400461c52`: 1 info
  - endpoint added

[Operation history](https://skmtc.dev/monta/apis/monta-partner-api/changes/api/v1/users/welcome-email/post.md)

---

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