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. |
| n/a | Body | false | Required | String | Request should be application/json content type with raw body containing the userspecs object and no parameter name. See userspecs documentation for details. |
Request should be application/json content type with raw body containing the userspecs object and no parameter name. See userspecs documentation for details on the object.
Request
Following are example requests:
HTTP
|
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 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 |
POST /api/1/user HTTP/1.1 Host: restapi.actonsoftware.com Authorization: Bearer f3f59c4c9eab1de6925438ccfb664ae Content-Type: application/json Cache-Control: no-cache [{ "userType":"Marketing", "email":"name3@domain.com", "firstName":"fName1", "lastName":"Surname1", "password":"pwxxx123", "title":"Marketing Manager", "phoneNumber":"111-111-1111", "mobileNumber":"111-111-1111", "faxNumber":"111-111-1111", "timeZone":"PT", "sendEmailConfirmation":"Y" }, { "userType":"Marketing", "email":"name4@domain.com", "firstName":"fName2", "lastName":"Surname2", "password":"pwyyy123", "title":"Marketing Manager2", "phoneNumber":"111-111-1111", "mobileNumber":"111-111-1111", "faxNumber":"111-111-1111", "timeZone":"PT", "sendEmailConfirmation":"Y", "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" } } ] |
curl
|
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 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 |
curl -X POST https://restapi.actonsoftware.com/api/1/user -H 'authorization: Bearer f3f59c4c9eab1de6925438ccfb664ae' -H 'cache-control: no-cache' -H 'content-type: application/json' -d '[{ "userType":"Marketing", "email":"name3@domain.com", "firstName":"fName1", "lastName":"Surname1", "password":"pwxxx123", "title":"Marketing Manager", "phoneNumber":"111-111-1111", "mobileNumber":"111-111-1111", "faxNumber":"111-111-1111", "timeZone":"PT", "sendEmailConfirmation":"Y" }, { "userType":"Marketing", "email":"name4@domain.com", "firstName":"fName2", "lastName":"Surname2", "password":"pwyyy123", "title":"Marketing Manager2", "phoneNumber":"111-111-1111", "mobileNumber":"111-111-1111", "faxNumber":"111-111-1111", "timeZone":"PT", "sendEmailConfirmation":"Y", "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" } } ]' |
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.
