Create new account user
|
1 |
POST /api/1/user |
Parameters
| Name | Parameter Type |
Allow Multiple |
Required/ Optional |
Data Type | Description |
|---|---|---|---|---|---|
| Authorization: | Header | False | Required | String (Bearer {access token}) | Pass the authentication token that was granted when you authorized access. |
| userspecs | form | false | Required | String | JSON formatted specs of the users to create. One or more users may be in the userspecs. See userspecs documentation for details. |
Note: See userspecs
Request
Following are example requests:
HTTP
|
1 2 3 4 5 6 7 8 9 10 11 12 |
POST /api/1/user HTTP/1.1 Host: restapi.actonsoftware.com Authorization: Bearer 781137c426b2db9fb0fe137fb6ffde79 Cache-Control: no-cache Content-Type: multipart/form-data; boundary=----WebKitFormBoundary7MA4YWxkTrZu0gW ----WebKitFormBoundary7MA4YWxkTrZu0gW Content-Disposition: form-data; name="userspecs" [{"userType":"Marketing","email":"e.fudd@domain.com","firstName":"Elmer","lastName":"Fudd","password":"pwxxx123","title":"Marketing Manager","phoneNumber":"111-111-1111","mobileNumber":"222-222-2222","faxNumber":"333-333-3333","timeZone":"PT","sendEmailConfirmation":"Y"},{"userType":"Sales","email":"b.bunny@domain.com","firstName":"Bugs","lastName":"Bunny","password":"pwyyy456","title":"Sales Manager","phoneNumber":"444-444-4444","mobileNumber":"555-555-5555","faxNumber":"666-666-6666","timeZone":"PT","sendEmailConfirmation":"N","marketingPrivileges":{ "launchPrivilege":"Not Allowed", "admin":"Y" }, "contactLists":{ "create":"Y", "delete":"N", "download":"Y" }, "content":{ "create":"Y", "delete":"N" }, "programs":{ "create":"Y", "delete":"N" }, "accountWideEmail":{ "view":"Y", "manage":"Y" }}] ----WebKitFormBoundary7MA4YWxkTrZu0gW |
curl
|
1 |
curl -X POST -H "Authorization: Bearer 863d23455dfb499ded19d17d5af19fc4" -H "Cache-Control: no-cache" -H "Content-Type: multipart/form-data" -F "userspecs=[{"userType":"Marketing","email":"e.fudd@domain.com","firstName":"Elmer","lastName":"Fudd","password":"pwxxx123","title":"Marketing Manager","phoneNumber":"111-111-1111","mobileNumber":"222-222-2222","faxNumber":"333-333-3333","timeZone":"PT","sendEmailConfirmation":"Y"},{"userType":"Sales","email":"b.bunny@domain.com","firstName":"Bugs","lastName":"Bunny","password":"pwyyy456","title":"Sales Manager","phoneNumber":"444-444-4444","mobileNumber":"555-555-5555","faxNumber":"666-666-6666","timeZone":"PT","sendEmailConfirmation":"N","marketingPrivileges":{ "launchPrivilege":"Not Allowed", "admin":"Y" }, "contactLists":{ "create":"Y", "delete":"N", "download":"Y" }, "content":{ "create":"Y", "delete":"N" }, "programs":{ "create":"Y", "delete":"N" }, "accountWideEmail":{ "view":"Y", "manage":"Y" }}]" "https://restapi.actonsoftware.com/api/1/user" |
Response
A successful request results in an HTTP 200 response with a JSON object with the results listing.
Each user is created independently. A failure of one user will not prevent other users from being created. The user creation is independent of the privilege setting (i.e. contactLists, accountWideEmail) so the user can be created successfully but not be assigned the proper privileges.
The response will indicate which actions were successful and which were not. Each element will have “status” of “ok” or “error” along with “email” to indicate which user the element is for.
An example JSON response:
|
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 |
[ { "email": "e.fudd@domain.com", "status": "ok", "privilegeResponses": [], "confirmationEmailResponse": { "email": "e.fudd@domain.com", "status": "ok" } }, { "email": "b.bunny@domain.com", "status": "ok", "privilegeResponses": [ { "email": "b.bunny@domain.com", "status": "error", "privilegeName": "ADMINISTRATOR" }, { "email": "b.bunny@domain.com", "status": "ok", "privilegeName": "LAUNCH_APPROVAL" }, { "email": "b.bunny@domain.com", "status": "ok", "privilegeName": "LIST_CREATE" }, { "email": "b.bunny@domain.com", "status": "ok", "privilegeName": "LIST_DELETE" }, { "email": "b.bunny@domain.com", "status": "ok", "privilegeName": "LIST_DOWNLOAD" }, { "email": "b.bunny@domain.com", "status": "ok", "privilegeName": "CONTENT_CREATE" }, { "email": "b.bunny@domain.com", "status": "ok", "privilegeName": "CONTENT_DELETE" }, { "email": "b.bunny@domain.com", "status": "ok", "privilegeName": "PROGRAM_CREATE" }, { "email": "b.bunny@domain.com", "status": "ok", "privilegeName": "PROGRAM_DELETE" }, { "email": "b.bunny@domain.com", "status": "ok", "privilegeName": "MESSAGE_VIEWER" }, { "email": "b.bunny@domain.com", "status": "ok", "privilegeName": "MESSAGE_EDITOR" }], "confirmationEmailResponse": { "email": "b.bunny@domain.com", "status": "ok" } } ] |
In the above example two users were created. The user e.fudd@domain.com did not specify any user privileges so that element is empty and the user received all the default settings. For the user b.bunny@domain.com the user privileges were specified in userspecs. All were properly applied except for “ADMINISTRATOR” privilege; that one failed so the default value remains in place.
