Skip to navigation
APIsUser Resources

Update a user

Updates the supplied attributes of an existing user.

Authentication

AuthorizationBearer

OAuth authentication of the form <token>.

Path parameters

userIdstringRequiredformat: "^usr_[a-zA-Z0-9]{10,22}$"
The unique identifier of the user.

Headers

X-Studies-Api-VersionstringOptional

Request

The user attributes to change.
namestringOptional1-255 characters
The name of the user.
timezonestringOptional<=30 characters
The user's IANA timezone identifier.
statusenumOptional

The standing of a user within your team. pending means the invitation has not yet been accepted, and revoked means access was withdrawn.

Allowed values:
metadatamap from strings to any or nullOptional
The metadata to merge into the user. Set an individual value to null to delete that key.

Response headers

X-RateLimit-LimitintegerOptional
The number of requests permitted in the current rate limit window.
X-RateLimit-RemainingintegerOptional

The number of requests still available in the current rate limit window. When several limits apply, this reflects the per-API-key limit, so a request can be rejected while this value is above zero.

X-RateLimit-ResetintegerOptional
The number of seconds until the current rate limit window resets.

Response

The updated user.
idstringformat: "^usr_[a-zA-Z0-9]{10,22}$"
Unique identifier for a user.
namestring<=255 characters
The name of the user.
emailstringformat: "email"
The email address of the user.
timezonestring or null<=30 characters
The timezone of the user, as an IANA timezone identifier.
statusenum

The standing of a user within your team. pending means the invitation has not yet been accepted, and revoked means access was withdrawn.

Allowed values:
metadatamap from strings to any or null
The metadata associated to the user.
created_atdatetime

UTC timestamp with microsecond precision, always suffixed with Z, in the form yyyy-MM-ddTHH:mm:ss.SSSSSSZ.

updated_atdatetime

UTC timestamp with microsecond precision, always suffixed with Z, in the form yyyy-MM-ddTHH:mm:ss.SSSSSSZ.

Errors

400
Bad Request Error
401
Unauthorized Error
403
Forbidden Error
404
Not Found Error
429
Too Many Requests Error