From Bright Pattern Documentation
• 5.2
<translate>= Create User= Creates a new user in the system.
Request
URL
http[s]://<host>/configapi/v2/user
For example:
http://example.com/configapi/v2/user
HTTP Method
POST
Content-Type
application/json
Parameters
Parameter | Data-Type | Description | Example |
loginId | string | The username of the new user | "sheila.thomas" |
firstName | string | The first name of the new user | "Sheila" |
lastName | string | The last name of the new user | "Thomas" |
team | string | The name of the team assigned to the new user | "Customer Service" |
string | The email address of the new user | "sheila.thomas@yourcompany.com" | |
roles | array | The role assigned to the new user | ["Agent", "Supervisor"] |
Example Request Body Content
{
"loginId" : "sheila.thomas",
"firstName" : "Sheila",
"lastName" : "Thomas",
"team" : "Customer Service",
"email": "sheila.thomas@yourcompany.com",
"roles": ["Agent"]
}
Response
In response to a successful request, the new user is created. Verify the new user in Contact Center Administrator > Users & Teams > Users.
Failed requests result in an error code, and the user is not created.
Response Codes
Code | Description |
200 OK | Success - user created |
400 | Bad request |
405 | Method not allowed |
</translate>