send-user-welcome-email.md

Send User Welcome Email

Send welcome email to a user. It requires the Send Emails permission.

HTTP Method	URL	Requires Auth
POST	api/v1/users.sendWelcomeEmail	yes

Payload Parameters

Argument	Example	Description
email`` *	test@example.com	The email address of the user to send the welcome email to.

Example Call

curl --location --request POST http://localhost:3000/api/v1/users.sendWelcomeEmail\
--header 'X-Auth-Token: myauth-token' \
--header 'X-User-Id: myuser-name' \
--data-raw '{
    "email":"test@email.com"
}'

Example Response

Success

{
    "success": true
}

Errors

The following error can occur upon the endpoint.

• Authorization: Requires an authentication token for the request to be made.
• SMPT not configured: SMTP is not properly configured on your workspace

{% tabs %} {% tab title=" Authorization" %}

{
    "success": false,
    "error": "unauthorized"
}

{% endtab %}

{% tab title="SMPT not configured" %}

{
    "success": false,
    "error": "SMTP is not configured [error-email-send-failed]",
    "errorType": "error-email-send-failed",
    "details": {
        "method": "sendWelcomeEmail"
    }
}

{% endtab %} {% endtabs %}

Change Log

Version	Description
6.8.0	Added