updateUserProperty method

Future<void> updateUserProperty({
  1. required String userId,
  2. required String key,
  3. required UserPropertyUpdate body,
})

Updates a property for the given user. Note, you cannot update the key of a user property, only the value. For more information about user properties, see Confluence entity properties. Note, these properties stored against a user are on a Confluence site level and not space/content level.

Permissions required: Permission to access the Confluence site ('Can use' global permission).

Implementation

Future<void> updateUserProperty(
    {required String userId,
    required String key,
    required UserPropertyUpdate body}) async {
  await _client.send(
    'put',
    'wiki/rest/api/user/{userId}/property/{key}',
    pathParameters: {
      'userId': userId,
      'key': key,
    },
    body: body.toJson(),
  );
}