The PUT /users/{userId}/schedules endpoint replaces the user’s schedules for the user matching the user ID provided.
In this page
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
curl -L -X PUT "https://***.api.newvoicemedia.com/useradmin/8e22b1fe-d2ea-403d-8c03-50eb21188e79/schedules" \ -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 an agentSchedules object in JSON format as in the request body.
This endpoint replaces the agents schedules.
- To add a new schedule, you must request the current schedule list and append the new schedule Id.
- To remove a new schedule, you must request the current schedule list and remove the target schedule Id from the list.
Example request body
{
"agentSchedules": [
{
"scheduleId": "bfe83c27-1daa-4f4f-9f80-e278bf79e327"
}
]
}
where:
agentSchedules. The schedules assigned to the agent.scheduleId. The unique ID of the schedule that the agent is assigned to.
Responses
Successful response
Successful requests return a 200 Success code.