Page Comparison

...

Panel

borderColor	#eeeeee
bgColor	white
titleColor	white
borderWidth	1
titleBGColor	#F79CA6#D6219C
borderStyle	solid
title	In this page

Table of Contents

Insert excerpt

	_ExcerptAPICloudNextGen
	_ExcerptAPICloudNextGen
nopanel	true

Headers

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

Authorization scopes supported:

Scope	Access granted
`users:write`	Entire endpoint

Request parameters

Path parameters

...

A user identifier. The user ID is unique within the account.

Tip
You can get a user's ID using the Users API endpoints.

Request body parameters

The endpoint accepts request body parameters:

...

A presence definition identifier. The presence definition ID is unique within the account.

Requests

Set presence of user with ID daab05ec-ba50-45af-a6fd-3b01cdc6f39b to presence with ID eaed6862-14fa-4114-be62-b8709b5d4a49

Code Block

language	powershell
theme	Midnight

curl -L -X PATCH "https://***.api.newvoicemedia.com/agents/daab05ec-ba50-45af-a6fd-3b01cdc6f39b/presence" 
-H "Authorization: Bearer <ACCESS_TOKEN>" -H "Accept: application/vnd.newvoicemedia.v1+json" 
-H "Content-Type: application/json" 
--data-raw "{
    \"presenceId\": \"eaed6862-14fa-4114-be62-b8709b5d4a49\"
}"

Body:

Code Block

language	js
theme	Midnight

{
    "presenceId": "eaed6862-14fa-4114-be62-b8709b5d4a49"
}

Responses

Responses to the endpoint return the updated presence for the specified user.

...

userId. A user identifier. The user ID is unique within the account.
updated. Date and time (UTC) of the last change of user's presence.
presence. The presence definition.
- presenceId. A presence definition identifier. The presence definition ID is unique within the account.
- selectable. Indicates if this presence has been configured to appear for Agents to select.
- category. Category of the presence definition.
  - categoryType. Type of presence definition category. Allowed values: LoggedOut, Away, ExtendedAway, Ready
  - description. Description of the presence category. Used for display purposes only.
- description. Description of the presence definition. Used for display purposes only.