NOTE: The element on the not-acceptable error response will not be available until the release April 2022 release of SafeZone.
The imports API allows creating multiple pre-registered user records at once and optionally sending out invitation emails to users if the invite attribute is set to true.
Users who are imported through this API will be able to receive mass notifications to their email address, even if they have not fully activated their account. If mobile numbers are provided, they will also be able to receive mass notifications via SMS.
Each import must define the user role via the application element, where com.criticalarc.omniguard is the personnel role and com.criticalarc.safezoneapp is the end user role.
In addition, each import must at least define the users email address and optionally other fields such as their name and phone number.
Each import response matches the order of the import request. An optional alias attribute can be added to match by name. The alias is not used during user creation or attached to the user record in any way.
The result will contain a collection of import elements matching each of the import elements in the query. If the import is successful, a user id of the newly created user is returned. If the import has failed, an error element will be returned instead.
The following error sub-types are currently defined, but the presence of the error element should be considered a failure.
This means a user with that email address already exists. This means the user has previously opted-out from the SafeZone service. This means one or more of the users fields are in an invalid format. This means something else went wrong, in which case you can contact support for assistance.