"Users" refers to all non-Agent users of the LiveVox platform. Currently, the Configuration API supports Create, Read, Update, Delete, List, and Get List Info methods for LiveVox user objects. There is also a Find Matching LiveVox Users method that returns a list of LiveVox Users that match specific criteria.

In order to use the methods listed that perform operations on LiveVox User objects, the user of the API must belong to either the Sysadmin or Superuser role. These roles are defined in the LiveVox Configuration Manager and correspond to users who can administer Users through the LiveVox user interfaces. Members of the Superuser role will not be able to perform operations on users that are members of the Sysadmin role, nor will Sysadmin users appear in the results of the List methods described below, when performed by Superusers.

Create LiveVox User

Description: Creates a new LiveVox User.

User Roles: Sysadmin or Superuser

Method: POST /configuration/lvusers

Parameters:

None

Body:

KeyTypeMandatory?Description
clientIdInteger (ID)NoThe ID of the Client under which the LiveVox User will be created.
userNameStringYesUsername the LiveVox User will use when logging onto the LiveVox platform
firstNameStringYesFirst name of the LiveVox User
lastNameStringYesLast name of the LiveVox User
passwordStringYesPassword of the LiveVox User. The password must comply with the same rules as when a User is created or updated through the LVP GUI. Specifically, the password must be a minimum of 8 characters, containing at least 1 digit and cannot match any of the previous 3 passwords.
emailStringNoEmail address of the LiveVox User
roleEnumYes

The security role to assign to the new LiveVox User. Possible values are:

  • SUPER_USER
  • SYS_ADMIN
  • IT_USER
  • MANAGER
  • REPORT_ADMIN
  • AUDITOR
  • CLIENT_AUDITOR
  • ALERTS_ONLY
serviceArrayNo

An array of Service IDs to assign to the LiveVox User.

KeyTypeMandatory?Description
idInteger (ID)YesService ID

Note: The user making the request to create the LiveVox User will only be able to assign Services for which he has permission.

 optionalManagerPowersObjectNo

Allows the user to define the "optional powers" for a LiveVox User, when that User is assigned the MANAGER role.

KeyTypeMandatory?Description
editDoNotCallListsBooleanNoProvides the ability to edit Do Not Call Lists
dialCellPhonesBooleanNoProvides the ability to specify whether the dialing campaign will or will not include cell phones
administerAgentsBooleanNoProvides the ability to create, update, and delete Agents
dialingStrategiesBooleanNoProvides the ability to configure Dialing Strategies used by Campaigns
campaignTemplatesBooleanNoProvides the ability to create and configure Campaign Templates
uploadCampaignsBooleanNoProvides the ability to upload calling lists into the LiveVox system
modifyServicesBooleanNoProvides the ability to change the attributes of a Service
callRecordingReportBooleanNoProvides the ability to access the Call Recording Report
downloadCallRecordingBooleanNoProvides the ability to download a call recording
accessCampaignTemplatesBooleanNoProvides the ability to access to Campaign Templates
readContactEditorBooleanNoProvides the ability to access to Contact Manager
listenCallRecordingBooleanNoProvides the permission to stream (playback) call recording
downloadScreenRecordingBooleanNoProvides the ability to download the screen recording
accessAccountsBooleanNoProvides the access to Accounts
downloadVoicemailRecordingBooleanNoProvides the ability to download voicemail recording
streamVoicemailRecordingBooleanNoprovides the permission to stream (playback) voicemail recording
accessTicketingBooleanNoProvides the ability to access to Ticketing
voicemailRecordingReportBooleanNoProvides the ability to access to Voicemail Recording Report

Note: If a value for an optional power is not provided when creating a new LiveVox MANAGER User, the default value is false.

Response Code: 201 Created

Body:

KeyTypeMandatory?Description
idInteger (ID)YesThe ID of the newly created LiveVox User.

Create a new LiveVox User

#Request (JSON)
POST /configuration/lvusers/
Host: localhost.com
Content-Type: application/json
Accept: application/json
 
{
  "firstName": "Manager_User",
  "lastName": "Documentation",
  "userName": "manager_user",
  "service": [
    {
      "id": 85304
    },
    {
      "id": 87284
    }
  ],
  "optionalManagerPowers": {
    "editDoNotCallLists": true,
    "dialCellPhones": true,
    "administerAgents": true,
    "dialingStrategies": false,
    "campaignTemplates": false,
    "uploadCampaigns": false,
    "modifyServices": true,
    "callRecordingReport": true,
    "downloadCallRecording": false,
    "readContactEditor": false,
    "listenCallRecording": true,
    "accessCampaignTemplates": true,
    "downloadScreenRecording": true,
    "accessAccounts": false,
    "downloadVoicemailRecording": true,
    "streamVoicemailRecording": true,
    "accessTicketing": false,
    "voicemailRecordingReport": false
  },
  "password": "password123",
  "email": "abc@gmail.com",
  "clientId": "85276",
  "role": "MANAGER"
}
 
#Response (JSON)
201 Created
Content-Type: application/json
 
{
  "id": 161420
}
CODE

Example of request to create a LiveVox User, with an invalid password

#Request (JSON)
POST /configuration/lvusers/
Host: localhost.com
Content-Type: application/json
Accept: application/json
 
{
  "firstName": "Manager_User1",
  "lastName": "Documentation",
  "userName": "manager_user1",
  "service": [
    {
      "id": 85304
    },
    {
      "id": 87284
    }
  ],
  "optionalManagerPowers": {
    "editDoNotCallLists": true,
    "dialCellPhones": true,
    "administerAgents": true,
    "dialingStrategies": false,
    "campaignTemplates": false,
    "uploadCampaigns": false,
    "modifyServices": true,
    "callRecordingReport": true,
    "downloadCallRecording": false,
    "readContactEditor": false,
    "listenCallRecording": true,
    "accessCampaignTemplates": true,
    "downloadScreenRecording": true,
    "accessAccounts": false,
    "downloadVoicemailRecording": true,
    "streamVoicemailRecording": true,
    "accessTicketing": false,
    "voicemailRecordingReport": false
  },
  "password": "",
  "email": "abc1@gmail.com",
  "clientId": "85276",
  "role": "MANAGER"
}
 
#Response
400 Bad Request
Content-Type: application/json
 
{
  "code": 202,
  "message": "Missing required field [password]"
}
CODE

Delete LiveVox User

Description: Deletes a LiveVox User.

User Roles: Sysadmin or Superuser

Parameters:

Path/Query Parameter NameVariable NameTypeMandatory?Description
iduserIdInteger (ID)TrueID of the LiveVox User you want to delete

Body:

None

Response Code: 204 No Content

Body:

None

Delete an existing LiveVox User

#Request
DELETE /configuration/lvusers/123662
Host: localhost.com

#Response
204 No Content
CODE

Attempt to delete a LiveVox User that does not exist

#Request
DELETE /configuration/lvusers/12345
Host: localhost.com

#Response
404 Not Found
CODE

Find Matching LiveVox Users

Description:  Retrieves list of LiveVox Users who match either a supplied Username or Last Name and, optionally, role. Searches are case-insensitive, and partial matches are supported.

User Roles: Sysadmin or Superuser

Method: POST /configuration/lvusers/search?[client={clientId}&]count={n}&offset={n}

Parameters:

Path/Query Parameter NameVariable NameTypeMandatory?Description
clientclientIdInteger (ID)NoSpecifies the Client for which you want to retrieve the list of matching Agents.
countnIntegerYesSpecifies the number of items to return in the list. There is a hard cap of 1000 items.
offsetnIntegerYesSpecifies the offset from 0, based on count, to start listing from.

Body:

Key or AttributeTypeMandatory?Description
usernameStringYes*Username of the LV User to search for
lastNameStringYes*Last name of LV User(s) to search for
roleStringNoFilters the results so that only matching Users with the specified role are returned.

*Only one of the two elements (username or lastName) can be used as the primary search criterion for this request.

  • It is the responsibility of the client application to ensure that only one type of primary search criterion is included in the query. The LiveVox API does not provide this validation logic on the server. If more than one type of primary search criterion is included in the query, the result is unpredictable.
  • Partial matches are supported, and the search is case-insensitive. That is, if jam is provided for the lastName parameter, it could return matches such as Jamison, James, Rajam, etc.

Response Code: 200 OK

Body:  

KeyTypeMandatory?Description
nextURINoA URI for the next page of entries. If next is not present, or blank, then there are no pages after this one.
userArrayNo

A container for a page of LiveVox User entries. The page size is controlled via count and offset in the request.

KeyTypeMandatory?Description
idInteger (ID)YesInternal ID of the User in the LiveVox system
userNameStringYesUsername the User uses to log into the LiveVox Platform, including the LiveVox Voice Platform (LVP) application
firstNameStringYesFirst name of the LiveVox User
lastNameStringYesLast name of the LiveVox User
lastLoginDateTimeNoDate/time of the User's last login to the LiveVox Platform
lastLoginIpStringNoThe IP address from which the agent logged in the last time
roleStringYes

The role of the User. Possible values are:

  • SUPER_USER
  • SYS_ADMIN
  • IT_USER
  • MANAGER
  • REPORT_ADMIN
  • AUDITOR
  • CLIENT_AUDITOR
  • ALERTS_ONLY

 

Retrieve the LiveVox User(s) who match the provided username and role

#Request (JSON)
POST /configuration/lvusers/search?count=10&client=49551&offset=0
Host: localhost.com
Content-Type: application/json
Accept: application/json
 
{
"username":"manager1",
"role":"MANAGER"
}

#Response (JSON)
200 OK
Content-Type: application/json

{
  "user": [
    {
      "firstName": "Manager",
      "lastName": "One",
      "userName": "manager1",
      "lastLogin": 1549386919000,
      "lastLoginIp": "201.103.105.141",
      "id": 117368,
      "role": "MANAGER"
    }
  ]
}
CODE

Retrieve the LV User(s) who match the provided last name

#Request (JSON)
POST /configuration/lvusers/search?count=10&client=4199&offset=0
Host: localhost.com
Content-Type: application/json
Accept: application/json
 
{
"lastName":"Smith"
}

#Response (JSON)
200 OK
Content-Type: application/json

{
   "user":    [
            {
         "id": 97747,
         "userName": "admin_jsmith",
         "firstName": "Jerry",
         "lastName": "Smith",
         "lastLogin": null,
	     "role": "MANAGER"
      },
            {
         "id": 97853,
         "userName": "report_Todd",
         "firstName": "Todd",
         "lastName": "Smith",
         "lastLogin": null,
	     "role": "AUDITOR"
      },
            {
         "id": 98784,
         "userName": "asmith1",
         "firstName": "Alison",
         "lastName": "Smith",
         "lastLogin": null,
	     "role": "MANAGER"
      },
            {
         "id": 99748,
         "userName": "janice_smith",
         "firstName": "Janice",
         "lastName": "Smithsonian",
         "lastLogin": null,
	     "role": "SYS_ADMIN"
      },
            {
         "id": 113766,
         "userName": "asmith2",
         "firstName": "Adrienne",
         "lastName": "Smithers",
         "lastLogin": null,
	     "role": "AUDITOR"
      },
            {
         "id": 114967,
         "userName": "abel_smith",
         "firstName": "Abel",
         "lastName": "Smith",
         "lastLogin": null,
	     "role": "SYS_ADMIN"
      }
   ],
   "next": null
}
CODE

Invalid FindMatchingLiveVoxUsers request

#Request (JSON)
POST /configuration/lvusers/search?count=10&client=4199&offset=0
Host: localhost.com
Content-Type: application/json
Accept: application/json
 
{
"lastName":"Smith",
"username":"jsmith"
}

#Response (JSON)
400 Bad Request
Content-Type: application/json

{
   "errorCode": 202,
   "errorMessage": "Invalid input [exactly one of username or lastName is required]"
}
CODE

Get LiveVox User List Info

Description: Gets metadata for a list of Users.

User Roles: Sysadmin or Superuser

Method: GET /configuration/lvusers/info[?client={clientId}]

Parameters:

Path/Query Parameter NameVariable NameTypeMandatory?Description
clientclientIdInteger (ID)NoRestricts the list to entries that are specifically associated with this particular Client.

Body:

None

Response Code:  200 OK

Body:

Key or AttributeTypeMandatory?Description
sizeIntegerYesTotal number of entries in the list.
lastModifiedDateTimeNoThe last date & time that the list was updated. This information might not be available. This is formatted according to the definition of dateTime in the XML Schema specification. For JSON responses, it is represented as the number of milliseconds since midnight on January 1, 1970 (GMT).

If a user with a Superuser role makes this request, the size of the list returned in the response will not take into account any users belonging to the Sysadmin role.

Get the metadata for a list of Users, filtered by a Client

#Request (JSON)
GET /configuration/lvusers/info?client=4199
Host: localhost.com
Content-Type: application/json
Accept: application/json

#Response (JSON)
200 OK
Content-Type: application/json

{
   "size": 117,
   "lastModified": 1245152417000
}
CODE

List LiveVox Users

Description: Lists Users configured for a Client.

User Roles: Sysadmin or Superuser

Method: GET /configuration/lvusers?[client={clientId}&]count={n}&offset={n}

Parameters:

Path/Query Parameter NameVariable NameTypeMandatory?Description
clientclientIdInteger (ID)NoSpecifies the Client for which you want to retrieve the list of Users
countnIntegerYesSpecifies the number of items to return in the list. There is a hard cap of 1000 items.
offsetnIntegerYesSpecifies the offset from 0, based on count, to start listing from.

Body:

None

Response Code: 200 OK

Body:

KeyTypeMandatory?Description
nextURINoA URI for the next page of entries. If next is not present, or blank, then there are no pages after this one.
userArrayNo

A container for a page of User entries. The page size is controlled via count and offset in the request.

KeyTypeMandatory?Description
idInteger (ID)YesInternal ID of the User
userNameStringYesUsername of the User
firstNameStringYesFirst name of the User
lastNameStringYesLast name of the User
lastLogindateTimeNoTimestamp representing the last date/time when this User logged into the LiveVox platform
lastLoginIpStringNoThe IP address from which the agent logged in the last time.
roleStringYes

The role of the User. Possible values are:

  • SUPER_USER
  • SYS_ADMIN
  • IT_USER
  • MANAGER
  • REPORT_ADMIN
  • AUDITOR
  • CLIENT_AUDITOR
  • ALERTS_ONLY

If a user with a Superuser role makes this request, the response will not include any users belonging to the Sysadmin role.

Get a list of Users for a Client

#Request (JSON)
GET /configuration/lvusers?count=5&client=49551&offset=10
Host: localhost.com
Content-Type: application/json
Accept: application/json

#Response (JSON)
200 OK
Content-Type: application/json

{
  "user": [
    {
      "firstName": "livevox",
      "lastName": "lvqapass1",
      "userName": "LV_ATG",
      "lastLogin": 1551088892000,
      "lastLoginIp": "52.2.171.102",
      "id": 157924,
      "role": "SYS_ADMIN"
    },
    {
      "firstName": "DO NOT DELETE",
      "lastName": "ATG USER",
      "userName": "LV_ATG_DEMO",
      "lastLogin": 1538640002000,
      "lastLoginIp": "184.72.85.204",
      "id": 161821,
      "role": "SYS_ADMIN"
    },
    {
      "firstName": "DO NOT DELETE",
      "lastName": "ATG USER",
      "userName": "LV_ATG_DEV",
      "lastLogin": 1551081601000,
      "lastLoginIp": "54.84.56.43",
      "id": 161820,
      "role": "SYS_ADMIN"
    },
    {
      "firstName": "DO NOT DELETE",
      "lastName": "ATG USER",
      "userName": "LV_ATG_STG",
      "id": 159105,
      "role": "SYS_ADMIN"
    },
    {
      "firstName": "H",
      "lastName": "P",
      "userName": "LV_HPTEST",
      "lastLogin": 1515938173000,
      "lastLoginIp": "67.191.138.103",
      "id": 158020,
      "role": "SYS_ADMIN"
    }
  ],
  "next": "configuration/lvusers/?client=49551&offset=15&count=5"
}
CODE

Read LiveVox User

Description: Gets information about a User.

User Roles: All users, however users other than sysadmin or superuser can only read their own details

Method: GET /configuration/lvusers/{id}

Parameters:

Path/Query Parameter NameVariable NameTypeMandatory?Description
iduserIdInteger (ID)YesThe ID of the User you want to query

Body:

None

Response Code: 200 OK

Body:

KeyTypeMandatory?Description
userNameStringYesName used by the User when logging into the LiveVox platform
firstNameStringYesFirst name of the User
lastNameStringYesLast name of the User
emailStringYesEmail address of the User. Used to provide alerts to the User.
roleEnumYes

The security role of the LiveVox User. Possible values are:

  • SUPER_USER
  • SYS_ADMIN
  • IT_USER
  • MANAGER
  • REPORT_ADMIN
  • AUDITOR
  • CLIENT_AUDITOR
  • ALERTS_ONLY
clientIdInteger (ID)NoID of the Client under which the User is registered
lastLoginDateTImeNoDate & Time of the last successful login by the User
lastLoginIpStringNoThe IP address from which the agent logged in the last time
lockedBooleanYesIndicates whether the User's account is locked, which can occur when the User exceeds the maximum number of allowable invalid login attempts.
passwordLastModifiedDateTimeNoIndicates the last date/time the User's password was changed. Will only display if password management is enabled.
serviceArrayNo

Array of Service IDs the User has permission to access.

KeyTypeMandatory?
idInteger (ID)Yes
alertArrayNo

Array of Alerts configured for the User to receive.

KeyTypeMandatory?Description
alertIdIDYesID of the Alert
nameStringYesName of the Alert
levelEnumYesDefines the level of the alert. Possible values are ERROR, INFO, or WARNING
optionalManagerPowersObjectNo

Specifies the additional security privileges assigned to this User. Only applies when the User is a "Manager".

KeyTypeMandatory?Description
editDoNotCallListsBooleanYesProvides the ability to edit Do Not Call Lists
dialCellPhonesBooleanYesProvides the ability to specify whether the dialing campaign will or will not include cell phones
administerAgentsBooleanYesProvides the ability to create, update, and delete Agents
dialingStrategiesBooleanYesProvides the ability to configure Dialing Strategies used by Campaigns
campaignTemplatesBooleanYesProvides the ability to create and configure Campaign Templates
uploadCampaignsBooleanYesProvides the ability to upload calling lists into the LiveVox system
modifyServicesBooleanYesProvides the ability to change the attributes of a Service
callRecordingReportBooleanYesProvides the ability to access the Call Recording Report
downloadCallRecordingBooleanYesProvides the ability to download a call recording
accessCampaignTemplatesBooleanYesProvides the ability to access to Campaign Templates
readContactEditorBooleanYesProvides the ability to access to Contact Manager
listenCallRecordingBooleanYesProvides the permission to stream (playback) call recording
downloadScreenRecordingBooleanYesProvides the ability to download the screen recording
accessAccountsBooleanYesProvides the access to Accounts
downloadVoicemailRecordingBooleanYesProvides the ability to download voicemail recording
streamVoicemailRecordingBooleanYesprovides the permission to stream (playback) voicemail recording
accessTicketingBooleanYesProvides the ability to access to Ticketing
voicemailRecordingReportBooleanYesProvides the ability to access to Voicemail Recording Report
  • A user with a Superuser role will not be able to use this request to retrieve information about a user belonging to the Sysadmin role. If this is attempted, the response will be a 403 error.
  • The list of Services in the response will only include Service IDs to which the requesting user has permission.

Read configuration properties of an existing LiveVox User

#Request (JSON)
GET /configuration/lvusers/161420
Host: localhost.com
Content-Type: application/json
Accept: application/json

#Response (JSON)
200 OK
Content-Type: application/json

{
  "firstName": "Manager_User",
  "lastName": "Documentation",
  "userName": "manager_user",
  "lastLogin": 1602837878000,
  "lastLoginIp": "10.40.234.107",
  "service": [
    {
      "id": 85304
    },
    {
      "id": 87284
    }
  ],
  "alert": [],
  "optionalManagerPowers": {
    "editDoNotCallLists": true,
    "dialCellPhones": true,
    "administerAgents": true,
    "dialingStrategies": false,
    "campaignTemplates": false,
    "uploadCampaigns": false,
    "modifyServices": true,
    "callRecordingReport": true,
    "downloadCallRecording": false,
    "readContactEditor": false,
    "listenCallRecording": true,
    "accessCampaignTemplates": true,
    "downloadScreenRecording": true,
    "accessAccounts": false,
    "downloadVoicemailRecording": true,
    "streamVoicemailRecording": true,
    "accessTicketing": false,
    "voicemailRecordingReport": false
  },
  "email": "abc@gmail.com",
  "clientId": 85276,
  "role": "MANAGER"
  "locked": false,
  "passwordLastModified": 1602765060000
}
CODE

Update LiveVox User

Description: Updates the properties of a LiveVox User.

Services  cannot be assigned or removed with this method. To perform those updates, you need to use the discrete methods Update LiveVox User Add Service and Update LiveVox User Remove Service.

User Roles: Sysadmin or Superuser

Method: PUT /configuration/lvusers/{id}

Parameters:

Path/Query Parameter NameVariable NameTypeMandatory?Description
iduserIdInteger (ID)YesThe ID of the LiveVox User you want to update

Body:

KeyTypeMandatory?Description
firstNameStringNoUpdated first name of the LiveVox User
lastNameStringNoUpdated last name of the LiveVox User
passwordStringNo

New password for the LiveVox User. The password must comply with the same rules as when a User is created or updated through the LVP GUI. Specifically, the password must be a minimum of 8 characters, containing at least 1 digit and cannot match any of the previous 4 passwords.

emailStringNoUpdated email address of the LiveVox User
roleEnumNo

Updated security role of the LiveVox User. Possible values are:

  • SUPER_USER
  • SYS_ADMIN
  • IT_USER
  • MANAGER
  • REPORT_ADMIN
  • AUDITOR
  • CLIENT_AUDITOR
  • ALERTS_ONLY
unlockBooleanNoWhen set to true, you can unlock a LiveVox User whose account has been locked out by the system–for example when the User has exceeded the maximum number of allowable invalid login attempts.
optionalManagerPowersObjectNo

Allows the user to updated the "optional powers" for a LiveVox User, when that User is assigned the MANAGER role.

KeyTypeMandatory?Description
editDoNotCallListsBooleanNoProvides the ability to edit Do Not Call Lists
dialCellPhonesBooleanNoProvides the ability to specify whether the dialing campaign will or will not include cell phones
administerAgentsBooleanNoProvides the ability to create, update, and delete Agents
dialingStrategiesBooleanNoProvides the ability to configure Dialing Strategies used by Campaigns
campaignTemplatesBooleanNoProvides the ability to create and configure Campaign Templates
uploadCampaignsBooleanNoProvides the ability to upload calling lists into the LiveVox system
modifyServicesBooleanNoProvides the ability to change the attributes of a Service
callRecordingReportBooleanNoProvides the ability to access the Call Recording Report
downloadCallRecordingBooleanNoProvides the ability to download a call recording
accessCampaignTemplatesBooleanNoProvides the ability to access to Campaign Templates
readContactEditorBooleanNoProvides the ability to access to Contact Manager
listenCallRecordingBooleanNoProvides the permission to stream (playback) call recording
downloadScreenRecordingBooleanNoProvides the ability to download the screen recording
accessAccountsBooleanNoProvides the access to Accounts
downloadVoicemailRecordingBooleanNoProvides the ability to download voicemail recording
streamVoicemailRecordingBooleanNoprovides the permission to stream (playback) voicemail recording
accessTicketingBooleanNoProvides the ability to access to Ticketing
voicemailRecordingReportBooleanNoProvides the ability to access to Voicemail Recording Report

Note: If a value for a particular optional power is omitted when updating a LiveVox MANAGER User, the value will be assumed to be false.

The body of your request must contain at least one key (or attribute) that you want to update. Keys (or attributes) that you don't want to update can be omitted from the request.

Response Code: 204 No Content

Body:

None

Update properties of a LiveVox User

#Request (JSON)
PUT /configuration/lvusers/122935
Host: localhost.com
Content-Type: application/json
Accept: application/json
 
{
  "optionalManagerPowers": {
    "editDoNotCallLists": false
  },
  "firstName": "Manager1",
  "email": "manager1@livevox.com"
}
 
#Response (JSON)
204 No Content
CODE

Unlock a LiveVox User whose account has been locked

#Request (JSON)
PUT /configuration/lvusers/122935
Host: localhost.com
Content-Type: application/json
Accept: application/json
 
{
  "unlock": true
}
 
#Response (JSON)
204 No Content
CODE

Example of request to update a LiveVox User, with an invalid password

#Request (JSON)
PUT /configuration/lvusers/122935
Host: localhost.com
Content-Type: application/json
Accept: application/json
 
{
  "password": "123"
}
 
#Response (JSON)
400 Bad Request
Content-Type: application/json
 
{
  "code": 202,
  "message": "Invalid password [Password must be at least 8 characters long]"
}
CODE

Update LiveVox User Add Service

Description: Assigns a Service to an existing LiveVox User.

After using this method to give a User access to a Service you can either create a new session id using the login method or wait 5 min for the permissions of the current session id to update.

User Roles: Sysadmin or Superuser

Method: PUT /configuration/lvusers/{user}/services/{id}

Parameters:

Path/Query Parameter NameVariable NameTypeMandatory?Description
useruserIdInteger (ID)YesID of the LiveVox User to whom you want to assign the Service
idserviceIdInteger (ID)Yes

ID of the Service you want to assign to the LiveVox User

Body:

None

Response Code: 204 No Content

Body:

None

Assign a Service to an existing LiveVox User

#Request (JSON)
PUT /configuration/lvusers/122935/Services/17885
Host: localhost.com
Content-Type: application/json
Accept: application/json
 
#Response
204 No Content
CODE

Update LiveVox User Remove Service

Description: Removes a Service assignment from an existing LiveVox User.

User Roles: Sysadmin or Superuser

Method: DELETE /configuration/lvusers/{user}/services/{id}

Parameters:

Path/Query Parameter NameVariable NameTypeMandatory?Description
useruserIdInteger (ID)YesID of the LiveVox User from whom you want to remove the Service assignment
idserviceIdInteger (ID)YesID of the Service you want to unassign from the LiveVox User

Body:

None

Response Code: 204 No Content

Body:

None

Remove a Service assignment from an existing LiveVox User

#Request (JSON)
DELETE /configuration/lvusers/122935/services/17885
Host: localhost.com
Content-Type: application/json
Accept: application/json
 
#Response
204 No Content
CODE

Top of Page