Create a New User

put https://slemma.com/api/v1/users

Creates a new user object.

Parameter URL

Parameter	Type	Required	Default value	Description
send_email	Boolean	No	false	If send_email is true, an email invitation will be sent to the user.

Returns

Returns a new user object if the call succeeded. If a Slemma account exists with the email address specified in the call, this call will simply add this user to a new team with the new Groupkey, Role and Type. The user can belong to any number of teams, but can be the owner of one team only.

The following are the examples of HTTP status codes including errors that API can generate

Response codes	Response сontent	Description
200 OK	The user object	The user has been created successfully.
400 Bad Request	Email cannot be empty	The field "Email" cannot be empty.
400 Bad Request	Invalid email address	The email address that was specified is invalid.
400 Bad Request	Invalid User Type:"IncorrectType"	The 'Type' parameter that was specified is invalid.
400 Bad Request	Invalid user role:"IncorrectRole"	The 'Role' parameter that was specified is invalid.
400 Bad Request	'Clients' feature is inactive.	You need the 'Clients' feature to be enabled for your account to create a new client.
400 Bad Request	CanCreate is not available for admins	'CanCreate' parameter is not allowed for users with 'Admin' role. Admins have full access by default.
400 Bad Request	Incorrect user Type	The 'Type' parameter that was specified doesn't match the corresponding group UserType .
400 Bad Request	Attribute not found, Key=112	A team attribute wasn't found.

Query Params

send_email

boolean

Defaults to false

Optional boolean to send a welcome email to the user. If send_email is false, no email invitation will be sent to the user. This may be useful for white labeled apps that want to handle Slemma announcements themselves.

Body Params

string

required

User's email address.

Role

string

required

Defaults to User

User role. The identifier of the role to give the user. 'Clients' can be a 'User' or a 'GroupAdmin' only. You can't create a team 'Owner'.

Type

string

required

Defaults to User

User type. The identifier of the type to assign to the user.

FirstName

string

First name of the user

LastName

string

Last name of the user

GroupKey

int32

Defaults to 0

The ID of an existing group to add this user to. The default value '0' adds the user without assigning them to any group.

Responses

Language

Credentials

Request


xxxxxxxxxx
33
1
cURL -i -X PUT
2
   -H teamid:131219
3
   -H sig:a214bb15a05b1cde9a1e31d19d0660b18fb37394
4
   -H Content-Type:application/json
5
   -d  {"FirstName":"Jack", 
6
        "LastName": "Smith", 
7
        "Email": "example@example.com", 
8
        "Role" : "User", 
9
        "Type" : "User", 
10
        "GroupKey":76, 
11
        "CanCreate": {
12
          "Dashboards": false,
13
          "DataSet": true,
14
          "Delivery": false,
15
          "Integrations": true,
16
          "Reports": false,
17
          "Sharing": false},
18
        "TeamAttributes": [{
19
          "Key": 2,
20
          "Value": "15260 Ventura Blvd, Suite 2230"},
21
          {"Key": 3,
22
          "Value": "+1 (805) 111-1111"}],
23
          "Groups": [
24
            {
25
              "GroupKey": 11555,
26
              "GroupRole": "GroupAdmin"
27
            },
28
            {
29
              "GroupKey": 11556,

Click Try It! to start a request and see the response here! Or choose an example:

application/json

text/plain

Parameter URL

Returns

200200

400400