/user/create


Create a new user. {N} identify record number, for example businessId1, businessId2, businessId3. password will be returned only if the user was successfully created.


Parameters

Name Type Required Example Description
allowCreatingBusinesses boolean (1,0) no 1 (default) Allow user to create / manage businesses
allowCreatingUsers boolean (1,0) no 0 (default) Allow user to create / manage other users
allowDeletingBusinesses boolean (1,0) no 0 (default) Allow user to delete businesses
allowOnlyCreatingCustomers boolean (1,0) no 0 (default) User will be able to just add new customers, everything else will be disabled.
allowAutoTagManagement boolean (1,0) no 0 (default) Allow user to manage Auto-Tag.
businessId{N} integer no 376 Managed business id.
clientId string(40) yes 04f78...9f9f3 Client id is a unique user identifier provided by GatherUp.
email string(email) yes john.smith@abc-company.com User email.
firstName string yes John User first name.
hash string(64) yes bd13a40...303f3c5 Hash is a digital request signature. Learn how to generate hash here.
lastName string yes Smith User last name.
sendPasswordEmail boolean (1,0) no 0 (default) Send email with password

Request

{  
   "email":"john.smith@abc-company.com",
   "firstName":"John",
   "lastName":"Smith",
   "clientId":"80338307b78b8d84c8b4d40e63e235cc312fcebe",
   "hash":"3b288032e87d12c08c95dc8a96128f19ec1ec207af383328413d18f9e0aaf1fd"
}

Response

{
   "password":"PMZDAPQHtnClMaa",
   "userId":73,
   "errorCode":0,
   "errorMessage":"Success"
}

Errors

errorCode errorMessage
-1 Unknown error
1 Invalid hash sign
2 Invalid clientId
3 Server error - please contact support
24 Someone already registered an account using this email
31 Unable to create user account
32 Provided parameters are invalid