Home Arrow Icon Knowledge base Arrow Icon Global Arrow Icon How can I ensure the welcome email is sent when creating a user via the REST API
    Joomla REST API


How can I ensure the welcome email is sent when creating a user via the REST API


To ensure a welcome email is sent when creating a user via the Joomla REST API, you can follow these steps:

1. Use the "sendEmail" parameter in your API request:
When making a POST request to create a new user, include the "sendEmail" parameter set to 1 in your JSON payload[3]. For example:

json
{
  "name": "John Doe",
  "username": "johndoe",
  "email": "
 <script language='JavaScript' type='text/javascript'>
 <!--
 var prefix = 'm&#97;&#105;lt&#111;:';
 var suffix = '';
 var attribs = '';
 var path = 'hr' + 'ef' + '=';
 var addy33531 = 'j&#111;hnd&#111;&#101;' + '&#64;';
 addy33531 = addy33531 + '&#101;x&#97;mpl&#101;' + '&#46;' + 'c&#111;m';
 document.write( '<a ' + path + '\'' + prefix + addy33531 + suffix + '\'' + attribs + '>' );
 document.write( addy33531 );
 document.write( '<\/a>' );
 //-->
 </script><script language='JavaScript' type='text/javascript'>
 <!--
 document.write( '<span style=\'display: none;\'>' );
 //-->
 </script>This e-mail address is being protected from spambots. You need JavaScript enabled to view it
 <script language='JavaScript' type='text/javascript'>
 <!--
 document.write( '</' );
 document.write( 'span>' );
 //-->
 </script>",
  "password": "securepassword",
  "groups": [2],
  "block": 0,
  "sendEmail": 1
}

2. Configure Joomla settings:
Ensure that your Joomla configuration has the following settings[3]:
- New User Account Activation = 'SELF'
- Send Password = 'Yes'

3. Use the latest Joomla version:
The functionality to send welcome emails for users created via the API was implemented in Joomla 4.1.1[3]. Make sure you're using this version or later.

4. Check email templates:
Verify that you have the appropriate email template set up in Joomla, such as "Users: New account with self-activation (with PW)"[3].

5. Consider custom implementation:
If you need more control over when and how the welcome email is sent, you might want to implement a custom solution. This could involve:
- Creating a separate endpoint to trigger the welcome email[1]
- Using a webhook or trigger that listens for new user creation and then calls your email-sending API[4]
- Implementing a serverless function or using a service like Pipedream to handle the email sending workflow[4]

6. Test thoroughly:
After implementation, thoroughly test the user creation process via the API to ensure that welcome emails are being sent as expected.

Remember that the exact behavior may depend on your specific Joomla version and configuration. If you're still experiencing issues, you may want to consult the Joomla documentation or community forums for the most up-to-date information on API functionality.

Citations:
[1] https://stackoverflow.com/questions/46651471/rest-api-welcome-email-best-practice
[2] https://support.zendesk.com/hc/en-us/community/posts/5817290699930-Send-Welcome-email-to-support-user-created-via-API
[3] https://forum.joomla.org/viewtopic.php?t=992104
[4] https://www.reddit.com/r/Supabase/comments/1cahu69/how_to_send_a_welcome_email_that_is_triggered/
[5] https://github.com/joomla/joomla-cms/issues/37128