From 609422071ff230102f5799de8a29c580413faf2b Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Ivar=20Conradi=20=C3=98sthus?= Date: Tue, 8 Feb 2022 20:47:01 +0100 Subject: [PATCH] docs: add "sendEmail" field to user-admin.md (#1329) --- website/docs/api/admin/user-admin.md | 7 +++++-- 1 file changed, 5 insertions(+), 2 deletions(-) diff --git a/website/docs/api/admin/user-admin.md b/website/docs/api/admin/user-admin.md index 937d330634..210a503db1 100644 --- a/website/docs/api/admin/user-admin.md +++ b/website/docs/api/admin/user-admin.md @@ -123,13 +123,16 @@ Creates a new use with the given root role. { "email": "some-email@getunleash.io", "name": "Some Name", - "rootRole": 2 + "rootRole": 2, + "sendEmail": true } ``` **Notes** -- `rootRole` can either be the role id or the unique name of the role (e.g: `Editor`). +- `email` - Required field. +- `rootRole` - can either be the role id or the unique name of the role (e.g: `Editor`). +- `sendEmail` - set to `true` if you want Unleash to send Welcome email to the new user. Do require the Unleash instance to be configured with email settings. #### Return values: {#return-values}