Send Welcome Email to User
- Print
- DarkLight
- PDF
Send Welcome Email to User
- Print
- DarkLight
- PDF
Article summary
Did you find this summary helpful?
Thank you for your feedback
Post
/api/v1/users.sendWelcomeEmail
Ensure that you have configured the email settings in your workspace to send emails.
Permission required: send-mail
Changelog
| Version | Description |
|---|---|
| 6.8.0 | Added |
Header parameters
X-Auth-Token
stringRequired
The authenticated user token.
ExampleRScctEHSmLGZGywfIhWyRpyofhKOiMoUIpimhvheU3f
X-User-Id
stringRequired
The authenticated user ID.
ExamplerbAXPnMktTFbNpwtJ
Body parameters
Example 1
{
"email": "[email protected]"
}object
email
string Required
The user's email address to which you want to send the welcome email.
Responses
200
OK
Success
{
"success": true
}object
success
boolean
400
Bad Request
SMPT not configured
{
"success": false,
"error": "SMTP is not configured [error-email-send-failed]",
"errorType": "error-email-send-failed",
"details": {
"method": "sendWelcomeEmail"
}
}object
success
boolean
error
string
errorType
string
details
object
method
string
401
Unauthorized
Authorization Error
{
"status": "error",
"message": "You must be logged in to do this."
}object
status
string
message
string
Was this article helpful?