The DELETE /api/users/{userId} endpoint allows for the removal of a specific user from the system. This method is useful for managing the deletion of users who should no longer have access or are no longer needed in the system. The user's identifier (userId) is included in the request URL.
Request Details
- HTTP Method:
DELETE - URL:
/api/users/{userId} - Authentication: Requires a Bearer token.
- Request Format: Not applicable (the request body is not used for this endpoint).
Request Parameters
| Field | Type | Required | Description |
|---|---|---|---|
| userId | string | Yes | The unique identifier of the user to delete. |
Authentication Required
Example Request
DELETE /api/users/usr-12345 HTTP/1.1
Host: api.plaspy.com
Authorization: Bearer your_auth_token
Response Parameters
| Field | Type | Required | Description |
|---|---|---|---|
| success | boolean | No | Indicates if the operation was successful. |
| error | string | No | Error message if the operation was not successful. |
| apiUsage | integer | No | API usage for the current request. |
| apiDailyUsage | integer | No | Daily API usage. |
Example Successful Response
{
"success": true,
"apiUsage": 50,
"apiDailyUsage": 200
}
Example Error Response
{
"success": false,
"error": "User not found",
"apiUsage": 50,
"apiDailyUsage": 200
}
This endpoint is essential for maintaining the system's cleanliness and security by allowing the removal of users who should no longer have access.
Index
- Welcome to Plaspy help
- Map
- Viewing a Device's Route History
- Device Control Panel
- Detailed Device Information
- Buttons on the Map
- Details
- Trip Statistics
- Device Menu
- GeoFences
- Bulk Alert Editing
- Enable map notifications
- Mileage Calculation
- Atributes
- Devices
- Marker Icon
- Information
- Sensors
- Reassign Digital Sensors
- Commands
- Alerts
- Types
- Configuration
- Reminders
- Limits
- History
- Setting Up a New Tracker
- Solution for Identifier Already in Use by Another Account
- Device Issues
- Email alerts sending limits
- Reports
- New Report
- My Account
- Billing Information
- Password Change
- Email Notifications
- Telegram Accounts
- Update Mobile Phone Number
- Primary Email
- Alternative Email
- Activate Two-Factor Authentication (2FA)
- Access Log
- Password Recovery
- Recover Username
- Delete Your Account
- Subscription
- Sign Up
- Activation Code
- Payment Methods
- Line Renewal
- Free Version
- Settings
- Organization
- Login
- Contact
- Styles
- Maps
- Email Templates
- Push Notifications
- Telegram Notifications
- WhatsApp Notifications
- Mobile App
- Statistics
- Activity Summary
- Groups
- Users
- Share Access
- SMS
- Mobile Application
- Developers
- Enable the API
- Rest API
- Authentication
- Devices API
- GET /api/devices
- GET /api/devices/{deviceId}
- GET /api/devices/{deviceId}/lastLocation
- POST /api/devices/{deviceId}/locations
- POST /api/devices/{deviceId}/alerts
- Groups API
- GET /api/groups
- POST /api/groups
- GET /api/groups/{groupId}
- PUT /api/groups/{groupId}
- PATCH /api/groups/{groupId}
- DELETE /api/groups/{groupId}
- Users API
- GET /api/users
- POST /api/users
- GET /api/users/countries
- GET /api/users/timeZones
- GET /api/users/{userId}
- PUT /api/users/{userId}
- PATCH /api/users/{userId}
- DELETE /api/users/{userId}
- Embed login on my website
- Embed the map on my website
Questions
We answer all support request within 24 business hours approximately, If you have a question that needs an immediate resolution, please contact us by other way.
We answer you in business hours, as soon as possible. We are located in Bogotá, Colombia, time zone (GMT-5).
Last modification: 2024-06-06 18:00:25