Create a new user and return its instance resource.
HTTP POST
POST /api/2013-12-01/Users
You must POST at least the following to create a new user.
| Parameter | Description |
|---|---|
| Name | First and/or Last name. Maximum of 65 characters. |
| Username | The username the user will use to login. |
| Password | Password for the new user. Must meet your site’s password complexity requirements. |
| Agencies[] | An array of Agencies this user should have access to. |
| Agencies[][Agency_ID] | Agency ID this user should have access to. |
| Agencies[][Group_ID] | Group ID of the Permission group this user should be assigned to in this agency. |
You may also set the following information when creating your new user. We recommend providing as much information as possible to make interacting with your users as easy as possible.
| Parameter | Description |
|---|---|
| Caller_ID | The phone number that should appear on recipient phones when this user makes phone calls or sends voice alerts. |
| Cell | User’s cell phone number. |
| Desk | User’s desk phone number. |
| User’s e-mail address. | |
| Language | The language for the user interfaces when the user logs in. Valid values include “en” or “es”. |
Example Request
$ curl -XPOST https://[Site Name].readyop.com/api/2013-12-01/Users \
-d "Username=JohnD" \
-d "Name=John Doe" \
-d "Password=P@ssw0rd1" \
-d "Agencies[0][Agency_ID]=1" \
-d "Agencies[0][Group_ID]=2" \
-d "Caller_ID=18132897620" \
-d "Cell=18132897620" \
-d "Language=en" \
-d "Email=john@readyop.com" \
-u "[API Account ID]:[API Token]"Request Result
{
"code": 0,
"status": 200,
"detail": "Success",
"timestamp": "2020-01-15T22:40:04+00:00",
"user": {
"User ID": 416
}
}