The JourneyApps API (V1) → 12. Managing Mobile Users

Managing Mobile Users

A mobile user's app is associated with an App Instance by means of an enrollment. The mobile user object type (e.g. user) returns additional data to facilitate this.

Parameters

To retrieve, create, update or delete mobile users, follow the instructions in these sections of the documentation for your mobile user object type (e.g. user):

• Retrieving All Objects
• Creating New Objects
• Updating an Object
• Deleting an Object

Response

The response includes all data normally returned by the basic operations: Create, Update, etc.

Additionally, enrollment details for the user are returned under an enrollment field:

• Whether the device has scanned the enrollment barcode and successfully enrolled
• The URL to which the app must connect to enroll, which is typically encoded in a QR code.

Example

We retrieve an object of our mobile user object type (i.e. user):

The response objects have an enrollment field that shows the user's enrollment status in enrolled and the URL for their enrollment barcode in url:

Resetting a Mobile User's enrollment

A mobile user can be re-enrolled with this function and subsequently scanning the enrollment barcode with the app.

Parameters

This function does not take any parameters.

Response

The response includes a success boolean value.

Example