POST https://restapi.actonsoftware.com/api/1/user
This endpoint allows you to create a new user or multiple users to the account.
Parameters
Name | Parameter Type |
Allow Multiple |
Required/ Optional |
Data Type | Description |
---|---|---|---|---|---|
Authorization: | Header | False | Required | String | Insert your generated access token. ("Bearer {access token}") |
Body | false | Required | String | A RAW body with JSON containing the userspecs data. |
See userspecs documentation for details on how to create the JSON required for the body of this request.
Response
The users are created independently and a failure of one user will not prevent other users from being created. The status of “ok” or “error” along with an email will indicate if the user was added successfully or not.
[ { "email": "john.doe@act-on.com", "status": "ok", "privilegeResponses": [], "confirmationEmailResponse": { "email": "john.doe@act-on.com", "status": "ok" } } ]
In the above response example, the user john.doe@act-on.com did not have specified user privileges so the element is empty and the user received all the default settings.
Code Examples
cURL
curl -X POST https://restapi.actonsoftware.com/api/1/user -H 'authorization: Bearer 6e8bfa02-0036-306d-893b-02246f52288d' -H 'content-type: application/json' -d '[{"userType":"Marketing","email":"john.doe@act-on.com","firstName":"John","lastName":"Doe","password":"password","title":"Marketing Manager","phoneNumber":"555-555-5555","mobileNumber":"555-555-5555","faxNumber":"555-555-5555","timeZone":"PT","sendEmailConfirmation":"Y"}]'