> For the complete documentation index, see [llms.txt](https://docs.samesystem.dev/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://docs.samesystem.dev/business-guides/employee-lifecycle-management/new-employees/welcome-email.md).

# Welcome email

{% hint style="info" %}
Only available for API v2.
{% endhint %}

SameSystem can automatically send a welcome email to an employee when the employee is created with a contract, starts a new employment or is rehired.

The default behavior differs between the two APIs:

* **API v1:** Welcome emails are **enabled by default**.
* **API v2:** Welcome emails are **disabled by default**.

### Controlling Welcome Emails in API v2

For supported API v2 operations, you can use the `sendWelcomeEmail` parameter to explicitly control whether a welcome email should be sent.

Set:

`sendWelcomeEmail: true`

to send a welcome email, or:

`sendWelcomeEmail: false`

to prevent the welcome email from being sent.

The option is available in the following endpoints:

* `users/Upsert with contracts`
* `users/Create with contract`
* `contracts/Insert`
* `contracts/Rehire`

> **Important:** If you want employees to receive a welcome email when using API v2, make sure to explicitly set `sendWelcomeEmail` to `true`. If not specified, the welcome email is disabled by default.

Refer to the individual API endpoints for the exact request structure and supported parameters.


---

# Agent Instructions
This documentation is published with GitBook. GitBook is the documentation platform designed so that both humans and AI agents can read, navigate, and reason over technical content effectively. Learn more at gitbook.com.

## Querying This Documentation
If you need additional information that is not directly available in this page, you can query the documentation by asking a question.

Perform an HTTP GET request on the following URL with the `ask` and `goal` query parameters:

```
GET https://docs.samesystem.dev/business-guides/employee-lifecycle-management/new-employees/welcome-email.md?ask=<question>&goal=<user_goal>
```

`ask` is the immediate question: it should be specific, self-contained, and written in natural language.
`goal` is what the user is ultimately trying to achieve, the reason they need the answer. Sharing it helps GitBook give you a better, more relevant answer. A goal is most helpful when it describes the outcome the user wants rather than restating the question. For example, with `ask=how do I create an API token`, a goal like `automate deployments from our CI pipeline` lets GitBook tailor the answer to that use case.

The response will contain a direct answer to the question and relevant excerpts and sources from the documentation.

Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.