Function: user.BulkModify

Performs a bulk of changes at once. Currently only accessible by the UI.

Syntax

{
	"method": "user.BulkModify",
	"params": {
		"create": "...",
		"update": "...",
		"set": "...",
		"delete": "...",
	},
	"id": "aaaaaaaa-bbbb-cccc-dddd-eeeeeeeeeeee"
}
AdvFuture<bool> BulkModify( std::optional<std::vector<UserRaw>> create = std::nullopt
	 std::optional<std::vector<UserRaw>> update = std::nullopt,
	 std::optional<std::vector<ObjectAspect>> set = std::nullopt,
	 std::optional<std::vector<AdvGuid>> _delete = std::nullopt );
public Task<bool> BulkModifyAsync(IList<UserRaw>? create = null,
		IList<UserRaw>? update = null,
		IList<ObjectAspect>? set = null,
		IList<Guid>? delete = null,
		CancellationToken ct = default);
bulkModify(toCreate?: UserRaw[] | undefined, toUpdate?: UserRaw[] | undefined, toSet?: ObjectAspect[] | undefined, toDelete?: string[] | undefined): Promise<boolean>;

Parameters

create : UserRaw[] optional

List of User Objects to create.

update : UserRaw[] optional

List of User Objects to update.

set : ObjectAspect[] optional

List of User Object properties to set.

delete : guid[] optional

List of User ids to delete.

Result : bool

True if successful.

Errors

Data.Forbidden

The caller does not have the required permissions to access the data. For additional information, see Data.Forbidden.

Remarks

This method requires API write access.