Create a User on the Platform

Sample request

The request below creates a user on the platform:

curl -X POST https://api.cxengage.net/v1/users -d '
{
    "email": "bjones@email.com",
    "roleId": "d68381b0-c8fa-11e5-b38c-5347eb4882ad",
    "firstName": "Bob",
    "lastName": "Jones",
    "externalId": "",
    "status": "enabled",
    "personalTelephone": null,
    "additionalRoleIds": []
 }

Request parameters

The table below lists the parameters you can include in a request:

Parameter	Required?	Type	Description
roleId	yes	UUID	The unique identifier of the platform role for the user. To get a list of platform user roles, use the Get a list of all platform roles. You can’t create or update users with roles that have greater permissions than those of your role. If, for example, your role is Supervisor, you cannot add a new user with the Administrator role.
email	yes	string	The user's email address.
firstName	no	string	The user’s first name.
lastName	no	string	The user’s last name.
externalId	no	string	The agent’s ID from a third-party system like Salesforce. Only include the externalID if you’re using CxEngage with a third-party system.
status	no	boolean	The current state of the invitation — pending, invited, or accepted.
personalTelephone	no	UUID	The user’s personal telephone number. This is not their extension for taking calls in the Skylight agent experience tools. All telephone numbers must be E.164 format — for example, +14162221122.
additionalRoleIds	no	array	An array of unique identifier for all the role IDs that are configured for the user.

Sample response

The request returns JSON structured like the example below:

{
    "result": {
        "aliasPlatformUserId": "533",
        "email": "bjones@email.com",
        "defaultTenant": null,
        "createdBy": "22b27350-fad0-11e5-aed6-5347eb4882ad",
        "additionalRoleIds": [],
        "personalTelephone": null,
        "updated": "2018-06-12T03:55:09Z",
        "resetPasswordExpiryDate": "2016-08-19T19:57:08Z",
        "firstName": "Bob",
        "created": "2016-06-16T13:10:32Z",
        "hasPassword": true,
        "externalId": "",
        "updatedBy": "b4aaa3a0-33c3-11e6-af8f-5347eb4882ad",
        "status": "enabled",
        "id": "b4aaa3a0-33c3-11e6-af8f-5347eb4882ad",
        "lastName": "Jones",
        "roleId": "d68381b0-c8fa-11e5-b38c-5347eb4882ad"
    }
}

Response parameters

The response includes the following parameters: