Web Services API | User web services | Send welcome mail
Modified on: Thu, 13 Apr 2023 4:30 PMSend welcome mail
Sends a welcome mail to a user, by id or username.
- Url: /integration/ws/management/rest/users/<id_or_externalId_or_commonId_or_username>/welcomeMail
- Method: POST
-
Headers:
- Accept: version/format header
- X-Cloud-Auth-Token*: authorization header
- X-Cloud-Synchronization: synchronization header (n/a in this service)
-
Responses:
-
200: OK. Content:
- status: generic status
- location: generic location of the resultant resource, if any
- message: generic success or error message, if any
-
responsePlatforms: response for lcloud platform. Each one with the content:
- status: status in the platform
- location: location of the resultant resource in the platform, if any
- message: success or error message in the platform, if any
-
200: OK. Content:
-
Url example by user id:
http://<tenant>.learningcloud.me/integration/ws/management/rest/users/ff808181556ee70e015572136a250012/welcomeMail
-
Url example by username:
http://<tenant>.learningcloud.me/integration/ws/management/rest/users/restuser.netex/welcomeMail
- Response example (synchronous and asynchronous):
{
"location": null,
"message": "Welcome mail sent to user",
"responsePlatforms": {
"management": {
"location": null,
"message": null,
"status": 202
}
},
"status": 204 }