GuidesRecipesAPI ReferenceChangelog
Log In
API Reference

Edit a user

patch
https://app.360learning.com/api/v2/users/

Required OAuth scope: users:write.

Edits specific fields of an existing user. Fields not included in the request payload remain unchanged.

Path Params
string
required

The unique ID of the user.

Body Params
string | null

The first name of the user.

string | null

The last name of the user.

string | null

The phone number of the user.

string | null

The role title of the user.

string | null

The organization that the user belongs to.

string | null

The value of the Additional information field in the user’s profile. This is not the value of the custom fields associated with the user.

string
enum

The default language of the user, in a bigram format (en, fr, de, etc.).

date-time | null

The date and time when the user will be deactivated, in the YYYY-MM-DDThh:mm:ss.sssZ format (ISO 8601 in Coordinated Universal Time (UTC)). Note that this parameter cannot be set on a user that is already deactivated.

string | null

The email address of the user. Must not correspond to an existing user in the company.

string | null

The unique ID of the primary group of the user.

string | null

The username that can be used to log in if the company allows it. Options are: lowercase letters, numbers, and the following special characters: _ - . + # ! $ % & ' * / = ? ^ ` { | } ~.

string | null

The unique ID of the media to use as the user's profile image. Set to null to remove the current image. Recommended size: 256px × 256px.

Headers
string
enum
required

The version of the API.

Allowed:
Responses

Updated 24 days ago

Language
Credentials
OAuth2
URL
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json

Updated 24 days ago