editUser method

Future<DynamiteResponse<UsersEditUserResponseApplicationJson, void>> editUser({
  1. required String key,
  2. required String value,
  3. required String userId,
  4. bool? oCSAPIRequest,
})

Update a value of the user's details.

Returns a Future containing a DynamiteResponse with the status code, deserialized body and headers. Throws a DynamiteApiException if the API call does not return an expected status code.

Parameters:

  • key Key that will be updated.
  • value New value for the key.
  • userId ID of the user.
  • oCSAPIRequest Required to be true for the API request to pass. Defaults to true.

Status codes:

  • 200: User value edited successfully

See:

  • editUserRaw for an experimental operation that returns a DynamiteRawResponse that can be serialized.

Implementation

Future<_i1.DynamiteResponse<UsersEditUserResponseApplicationJson, void>> editUser({
  required String key,
  required String value,
  required String userId,
  bool? oCSAPIRequest,
}) async {
  final rawResponse = editUserRaw(
    key: key,
    value: value,
    userId: userId,
    oCSAPIRequest: oCSAPIRequest,
  );

  return rawResponse.future;
}