Skip to main content

Device App User Update

The device app user updatedevice_app_user_update endpoint allows mobile applications and client systemsyou to update user profile information and settings.device details in the GATE system. This endpoint is commonly usedessential for profilemaintaining management,current preferenceuser updates,profiles, device associations, and userauthentication datacredentials synchronizationin acrossmobile devices.and IoT applications.

Base URL: https://gate.zequenze.com/api/v1

Authentication: All endpoints require a Bearer token:

Authorization: Bearer <your-api-token>

Overview

The Device App User Updatedevice_app_user_update API category provides functionality forto updatingupdate comprehensive user and device information within the GATE platform.system. This endpoint is designed specifically for mobile applications and client software that need to modify user profiles, preferences, and account settings.

Common scenarios include updating user profiles when users change their personal information, synchronizing user preferences across multiple devices, and maintaining up-to-date user data for personalized experiences. The endpoint accepts user data in a flexible format, allowing applications to update various user attributes in a single request.

This API is particularly useful for mobile applications that need to handlemaintain offlinesynchronized profileuser editsprofiles across multiple devices and syncplatforms.

them

Key whenFeatures:

connectivity
isUpdate restored,user orauthentication credentials (username, password) Manage device identifiers (IMEI, IMSI, ICCID) Synchronize user profiles with external systems Maintain device-to-user associations Handle user classification and service levels

Common Integration Scenarios:

    Mobile applications updating user profiles after login IoT device management systems synchronizing device information Customer management systems updating user classifications Multi-device applications maintaining user sessions Telecom operators managing subscriber information

    The endpoint accepts a comprehensive data payload that can include device identifiers, user credentials, and classification information, allowing for adminflexible interfacesupdates thatbased manageon useryour accountsapplication's acrossspecific an organization.needs.

    Endpoints

    POST /device_app_user_update/

    Description: Updates user information including profile details, preferences, and accountassociated settings.device details in the GATE system. This endpoint acceptsallows you to modify user datacredentials, device identifiers, external system mappings, and appliesuser classifications in a single request. It's designed for scenarios where user or device information has changed and needs to be synchronized across the updates to the specified user account, returning confirmation of the changes made.system.

    Use Cases:

    • Mobile appUser profile editingupdates whereafter users update their name, email,authentication or preferencesregistration changes
    Device replacement or upgrade scenarios requiring identifier updates Synchronization with external user management systems User class of service changes or upgrades Bulk user data updatesmaintenance from administrative interfaces Synchronization of user settings across multiple devices Integration with external systems that manage user informationoperations

    Full URL Example:

    https://gate.zequenze.com/api/v1/device_app_user_update/

    Parameters:

    Parameter Type In Required Description
    data string body Yes JSON string containing user and device information to update. Should include user ID and the fields to be modifiedupdate

    Request Body Structure:

    The data parameter should contain a JSON stringobject with the following structure:optional fields:

    {
    "user_id":"12345","profile":Field {Type "first_name":Description "John", "last_name": "Smith","email":"john.smith@example.com",number "phone":string "+1-555-0123"Device },number "preferences":(MSISDN) {- "notifications_enabled":typically true,the "language":phone "en",number "timezone": "America/New_York"},generic_id "device_info":string {Generic "device_id":unique "device_123",identifier "app_version":from "2.1.0",OS/App "platform":store "iOS" }}imei string International Mobile Equipment Identity imsi string International Mobile Subscriber Identity iccid string Integrated Circuit Card Identifier (SIM card ID) username string User's login username password string User's password (should be properly hashed) user_external_id string External system user identifier for integration user_class string User class of service or subscription tier

    cURL Example:

    curl -X POST "https://gate.zequenze.com/api/v1/device_app_user_update/" \
  -H "Authorization: Bearer YOUR_API_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{
    "data": "{
      \"user_id\number\": \"12345\+1234567890\",
      \"profile\": {\"first_name\generic_id\": \"John\com.example.app.user123\",
      \"last_name\imei\": \"Smith\123456789012345\",
      \"email\imsi\": \"john.smith@example.com\310120123456789\"},
      \"preferences\": {\"notifications_enabled\": true, \"language\iccid\": \"en\12345678901234567890\"},
      \"username\": \"john_doe\",
      \"password\": \"hashed_password_string\",
      \"user_external_id\": \"ext_user_456\",
      \"user_class\": \"premium\"
    }"
  }'

    Example Response:Response (201 Created):

    {
  "success": true,
  "message"number": "User information updated successfully"+1234567890",
  "user_id"generic_id": "12345"com.example.app.user123",
  "updated_fields"imei": [
    "profile.first_name"123456789012345",
  "profile.last_name"imsi": "310120123456789",
  "profile.email"iccid": "12345678901234567890",
  "preferences.notifications_enabled"username": "john_doe",
  "preferences.language"password": ]"hashed_password_string",
  "updated_at"user_external_id": "2024-01-15T14:30:22Z"ext_user_456",
  "version"user_class": 15"premium"
}

    Response Codes:

    Status Description
    201 Created - User information successfully updated successfully
    400 Bad Request - Invalid data format or missing required fields
    401 Unauthorized - Invalid or missing authentication token
    404
    Not Found - User ID not found in system 422 Unprocessable Entity - ValidationData validation errors in provided data 500 Internal Server Error - Server error processing the updateerror

    Common Use Cases

    Use Case 1: Mobile App User Profile UpdatesUpdate

    When usersa edituser updates their profile information in a mobile app, use this endpoint to sync the changes to the server. Include the user ID and only the fields that have been modified to minimize data transfer.

    Use Case 2: Settings Synchronization

    For applications that work across multiple devices,application, use this endpoint to synchronize userthe preferenceschanges with the GATE system, including updated credentials and settings.device Includeinformation.

    Use Case 2: Device Replacement Scenario

    When a user gets a new device informationor toSIM trackcard, whichupdate the device initiatedidentifiers (IMEI, IMSI, ICCID) while maintaining the update.same user account and external system mappings.

    Use Case 3: Administrative User ManagementClass Upgrade

    AdminWhen interfacesa canuser useupgrades thistheir endpointservice plan or subscription tier, update their user_class field to updatereflect userthe informationnew inlevel bulkof orservice makeand corrections to user profiles. Include comprehensive user data to ensure all necessary fields are updated.permissions.

    Use Case 4: External System Integration

    When integrating with external HR systems or identity providers, use this endpoint to keepSynchronize user information synchronizedbetween acrossGATE platforms.and external CRM or user management systems using the user_external_id field to maintain consistent user records.

    Use Case 5: Bulk User Maintenance

    Perform maintenance operations on user accounts, such as updating authentication credentials or device associations during system migrations or security updates.

    Best Practices

    • Validate Data Client-SideValidation:: Always validate user input before sending to the APIAPI, toespecially reducefor 422device errorsidentifiers like IMEI and improveIMSI userwhich experiencehave specific format requirements.

    • SendPassword OnlySecurity: ModifiedEnsure Fieldspasswords are properly hashed before transmission. Never send plain text passwords through the API.

    Partial Updates:: To optimize performance,You only need to include fields that haveare actually changedchanging in the updatedata requestpayload. The API supports partial updates, so omit unchanged fields to reduce payload size.

    HandleError OfflineHandling: Scenarios:Implement Storerobust failederror updateshandling locallyfor validation errors (422) and retryauthentication whenfailures connectivity(401). isParse restored,error using the version fieldresponses to preventprovide conflictsmeaningful feedback to users.

    Rate Limiting: Be mindful of API rate limits when performing bulk updates. Implement Properappropriate Errordelays Handling:or Displaybatching meaningfulstrategies errorfor messageslarge-scale tooperations.

    users based on the response codes and error details

    RateData LimitingConsistency:: ImplementWhen client-sideupdating ratedevice limitingidentifiers, ensure all related fields (IMEI, IMSI, ICCID) are consistent and belong to avoid overwhelming the APIsame withphysical rapiddevice successiveor updatesSIM card.

    DataExternal PrivacyID Mapping:: Ensure sensitive user information is properly encrypted during transmission and follow applicable privacy regulations

    Version Control: Use the returneduser_external_id versionfield numberconsistently to implementmaintain optimisticreliable lockingmappings between GATE and preventyour concurrentexternal systems.

    Logging and Monitoring: Log all update conflictsoperations for audit trails and implement monitoring to track successful updates and identify patterns in failures.

    Back to top