Send Welcome Email to User

Prev Next
Post
/api/v1/users.sendWelcomeEmail

Ensure that you have configured the email settings in your workspace to send emails.

Permission required: send-mail

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
object
email
string Required

The user's email address to which you want to send the welcome email.

Responses
200
400
401

OK

object
success
boolean