Update user by UUID

patch

https://api.percipio.com/content-discovery/v1/organizations/{orgId}/users/{id}

This service can only be used to update an existing user within Percipio.

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Path Params

orgId

uuid

required

Organization UUID

string

required

User UUID

Body Params

The values for the user are supplied in the request body

sendWelcomeEmail

boolean

Defaults to false

True for sending Welcome Email, false for suppressing welcome email; ignored on update.

externalUserId

string

length ≤ 255

Client system user identifier that is external to Percipio. This is typically the primary key for the user in your system.

isActive

boolean

Status of the user, only active users can access site.

role

string

Used to determine what functionality the user can access e.g. LEARNER, ADMIN, CONTENT_CURATOR, CONTENT_COORDINATOR, LEARNING_ADMIN, MANAGER.

customAttributes

array of objects

Organization defined custom attributes

customAttributes

isInstructor

boolean

Defaults to false

Instructor, user will act as a Instructor.

hasEnterpriseCoachingDashboard

boolean

Defaults to false

Coach, user will act as a Coach.

hasCoaching

boolean

Defaults to false

coaching privilege

hasEnterpriseCoaching

boolean

Defaults to false

Enterprise coaching privilege

isLXDCreator

boolean

Defaults to false

LX Design studio creator

isLXDPublisher

boolean

Defaults to false

LX Design studio publisher

Responses

401

Unauthorized

404

Not Found

422

Unprocessable Entity

500

Unexpected error

Language

Credentials

Bearer

URL

Loading…

Response

Click Try It! to start a request and see the response here! Or choose an example:

application/json

200OK