Create User Record

POST {{url}}/{{tenantName}}/admin/users/

NOTE: Available only if Admin Access -> User Provision
is set.

Users API url consist of the following structure

https://api.live.welkincloud.io/{}/admin/users

In our example, the url would be: https://api.live.welkincloud.io/gh/admin/users

  1. HTTP Method: POST
  2. HTTP URL: https://api.live.welkincloud.io/gh/admin/users

Note:

  • phone: when working with patients and fields such as phone, phone must be specified in the international format, E.164 format, without zero

Request Body

{"firstName"=>"Api", "lastName"=>"Client", "email"=>"test@test.com", "phone"=>nil, "timezone"=>nil, "credentials"=>nil, "username"=>"user.user", "mfaEnabled"=>false, "ssoAccess"=>false, "passwordAccess"=>true, "customUserAttributes"=>{"zoomId"=>"testId", "primaryLanguage"=>"english", "secondaryLanguage"=>"spanish"}, "applicationAccess"=>{"adminAccessEnabled"=>false, "auditSecurityAccessEnabled"=>false, "id"=>nil}}

HEADERS

KeyDatatypeRequiredDescription
tenantstring
instancestring