Update user role

put/v1/users/update

This API allows you to modify the role of a specific user in your BoldSign organization user account.

Code snippet

curl -X 'PUT' \
  'https://api.boldsign.com/v1/users/update' \
  -H 'accept: */*' \
  -H 'X-API-KEY: {your API key}' \
  -H 'Content-Type: application/json;odata.metadata=minimal;odata.streaming=true' \
  -d '{
  "userId": "77f0a721-xxxx-xxxx-xxxx-17fcb032xxxx",
  "userRole": "Admin"
}'
var apiClient = new ApiClient("https://api.boldsign.com", "{apikey}");
var userClient = new UserClient(apiClient);
var updateUser = new UpdateUser("77f0a721-xxxx-xxxx-xxxx-17fcb032xxxx", UserRoleType.Admin);
userClient.UpdateUser(updateUser);
import requests
url = "https://api.boldsign.com/v1/users/update"

payload = "{\n  \"userId\": \"77f0a721-xxxx-xxxx-xxxx-17fcb032xxxx\",\n  \"userRole\": \"Admin\"\n}"
headers = {
  'accept': '*/*',
  'X-API-KEY': '{your API key}',
  'Content-Type': 'application/json;odata.metadata=minimal;odata.streaming=true'
}
response = requests.request("PUT", url, headers=headers, data=payload)
print(response.text)
const axios = require('axios');
const response = await axios.put(
    'https://api.boldsign.com/v1/users/update',
    
    {
        'userId': '77f0a721-xxxx-xxxx-xxxx-17fcb032xxxx',
        'userRole': 'Admin'
    },
    {
        headers: {
            'accept': '*/*',
            'X-API-KEY': '{your API key}',
            'Content-Type': 'application/json;odata.metadata=minimal;odata.streaming=true'
        }
    }
);

Request body

NameType
userIdstringRequiredThe ID of the user account.
userRolestringRequiredRepresents a user role in their organization.

Example response

200 Success