Page Comparison

The PUT /users/{userId}/callbackNumbers endpoint replaces the user’s callback numbers for the user matching the user ID provided.

Panel

borderColor	#eeeeee
bgColor	white
titleColor	white
borderWidth	1
titleBGColor	#7ec9f4
borderStyle	solid
title	In this page

Table of Contents

Request parameters

Query parameters

...

Insert excerpt

	_ExcerptAPICloudNextGen
	_ExcerptAPICloudNextGen
nopanel	true

Headers

Header parameters in Requests (User Admin API) apply to this endpoint.

Authorization scopes supported:

Scope	Access granted
`users:write`	Entire endpoint

Parameters

`userID`

Type	Required	Example
String	True	`2f9207ca-8922-4245-bfc5-d8f42939e29a`

The user ID of the required user.

Requests

Example Request

Code Block

language	powershell
theme	Midnight

curl -L -X PUT "https://***.api.newvoicemedia.com/useradmin/users/8e22b1fe-d2ea-403d-8c03-50eb21188e79/callbackNumbers" \
-H "Content-Type: application/json" \
-H "Accept: application/vnd.newvoicemedia.v4+json" \
-H "Authorization: Bearer <ACCESS_TOKEN>" \
--data-raw "<JSON BODY>"

Request body parameters

The endpoint requires a callbackNumbers object in JSON format as in the request body.

Tip

This endpoint replaces the agents callback numbers.

To add a new callback number, you must request the current callback number list and append the new callback number Id.
To remove a new callback number, you must request the current callback number list and remove the target callback number Id from the list.

Example request body

Code Block

language	js
theme	Midnight

{
  "callbackNumbers": [
    {
      "callbackNumberId": "118135e7-5a08-b79d-d4c7-ae65bbb7181c"
    }
  ]
}

where:

callbackNumbers. The A list of callback numbers to assign to the user.
- callbackNumberId. The unique ID of the callback number.

Responses

Successful response

Successful requests return a 200 Success code.