Skip to main content
PATCH
/
management
/
v2.0
/
users
/
{userId}
Updates an user.
curl --request PATCH \
  --url https://api-trial.cognigy.ai/new/management/v2.0/users/{userId} \
  --header 'Authorization: Basic <encoded-value>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "id": "<string>",
  "name": "<string>",
  "acceptedTOS": true,
  "disabled": true,
  "cxoneEmail": "<string>",
  "cxoneId": "<string>",
  "newPassword": "<string>"
}
'
{
  "type": "Bad Request",
  "title": "Bad Request Error",
  "status": 400,
  "detail": "Validation failed. Missing payload.",
  "instance": "/v2.0/flows/5ce7c2d833ea1e04d7e6c432",
  "code": 1000,
  "traceId": "api--f84324f4-98eb-4f02-abdd-375a2e6c3c1f",
  "details": {}
}

Authorizations

ā€‹
Authorization
string
header
required

Basic Authentication used by routes designed for the Management-UI.

Headers

ā€‹
Accept
enum<string>

The default media type is application/hal+json. Use application/json for pure data results.

Available options:
application/json,
application/hal+json,
application/xml,
text/xml,
text/csv

Path Parameters

ā€‹
userId
string
required

The Id of the User

Required string length: 24

Body

application/json
ā€‹
id
string
ā€‹
name
string
ā€‹
acceptedTOS
boolean
ā€‹
disabled
boolean
ā€‹
cxoneEmail
string

The email address of the CXOne user, only required for NiCE CXOne users

ā€‹
cxoneId
string

The CXOne ID of the user, only required for NiCE CXOne users

ā€‹
newPassword
string

Response

The user is updated successfully.