Skip to navigation
APIsProject ResourcesProject Roles

Update a project role

Updates the specified project role by setting the values of the parameters passed.

Authentication

AuthorizationBearer

OAuth authentication of the form <token>.

Path parameters

projectRoleIdstringRequiredformat: "^prl_[a-zA-Z0-9]{10,22}$"
The unique identifier of the project role.

Headers

X-Studies-Api-VersionstringOptional

Request

The project role attributes to change.
namestringOptional1-255 characters
The name of the project role.
metadatamap from strings to any or nullOptional
The metadata to merge into the project role. 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 project role.
idstringformat: "^prl_[a-zA-Z0-9]{10,22}$"
Unique identifier for a project role.
namestring<=255 characters
The name of the project role.
metadatamap from strings to any or null
The metadata associated to the project role.
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