ModifiedUsersResult

Generic API response object with success or failure flag and related messages.

API Section: Objects

Type: Object

Properties

Name

Description

Required

Type

Format

failedModificationUsers

A list of the users that could not be modified

-

FailedItemId [ ]

failedValidationUsers

A list of the users that were wrongly formatted

-

FailedItemId [ ]

success

Boolean showing success or failure result.

-

boolean

errorMessage

Error message in case of failure

-

string

modifiedList

List of item ID's that have been affected by the function call. The type of ID depends on the function.

-

ItemId [ ]

Usages
  • /API3/access/createUsers
  • /API3/access/createUsersFromSearch
  • /API3/access/updateUsers
  • /API3/access/updateUsersFromSearch