;

Active/ Inactive User

This API activates or deactivates a user account, controlling their access to the system. When deactivated, the user's data is retained for future reference or potential reactivation.
Status Value Description
Active The user account is active and can access the system.
Inactive The user account is deactivated and cannot access the system, but their data is retained for future use.
POST https://apiv3.imocha.io/v3/accounts/user/status
  • Docs
  • Try it
Request Body Parameters
Field Type Required Default Description
email String Yes - Unique email ID for the user
status String Yes - Status of the user. Accepts only "Active" or "Inactive". Case-sensitive.
Sample Request Body 
Request Body

                                    
    {
       "email": "[email protected]",
       "status":"Active"
    }
                        

Request Body

                                    
    {
       "email": "[email protected]",
       "status":"Inactive"
    }
Successful response

Status 200 OK

Response

                                
    {
       "email": "[email protected]",
       "fullName": "Test User",
       "businessunitId": 170867,
       "status":"Active"
    }
Failed response

Status 400 Bad request

Response


    {
    "errors": [
        "Email address is in invalid format"
    ]
}
Failed response

Status 400 Bad request

Response


   {
  "errors": [
    "Status must be either 'Active' or 'Inactive'"
  ]
}
Parameter Value Description Parameter Type Data Type
email Unique email ID for the user Body String
Status Status of the user. Accepts only "Active" or "Inactive". Case-sensitive. Body String
  • Response Body