This endpoint allows you to create a new group within the system. It's essential for organizing devices and managing them efficiently by grouping them into logical units. Each group can have a unique name, description, and a list of associated devices.
Request Details
To create a group, you need to send a POST request with the group details in the request body. Ensure the request is authorized with a valid token.
Request Parameters
The request body must include the details of the group to be created.
Request Body Parameters
| Field | Type | Required | Description |
|---|---|---|---|
| name | string | Yes | The name of the group. Must be a non-empty string. |
| description | string | No | A description of the group. |
| devices | array | No | List of device IDs associated with the group. |
Example Request Body
{
"name": "New Group",
"description": "Description of the new group",
"devices": ["dev-456", "dev-789"]
}
Authentication Required
Example Request
POST /api/groups HTTP/1.1
Host: api.plaspy.com
Authorization: Bearer eyJhbGciOiJIUzUxMiIsInR5cCI6IkpXV...
Content-Type: application/json
{
"name": "New Group",
"description": "Description of the new group",
"devices": ["dev-456", "dev-789"]
}
Response Parameters
The response includes details of the newly created group.
| Field | Type | Required | Description |
|---|---|---|---|
| success | boolean | Yes | Indicates whether the request was successful. |
| error | string | No | Error message if the request failed. |
| apiUsage | integer | No | Total API usage at the time of the request. |
| apiDailyUsage | integer | No | Daily API usage at the time of the request. |
| id | string | No | Unique identifier of the created group. |
| name | string | Yes | Name of the group. |
| description | string | No | Description of the group. |
| devices | array | No | List of IDs of devices associated with the group. |
| creation | string | No | Date and time of group creation (in ISO 8601 format). |
| lastModified | string | No | Date and time of the last modification of the group (in ISO 8601 format). |
Example Successful Response
{
"success": true,
"error": null,
"apiUsage": 123,
"apiDailyUsage": 45,
"id": "grp-125",
"name": "New Group",
"description": "Description of the new group",
"devices": ["dev-456", "dev-789"],
"creation": "2023-06-01T12:00:00Z",
"lastModified": "2023-06-01T12:00:00Z"
}
Example Error Response
{
"success": false,
"error": "Invalid input",
"apiUsage": 123,
"apiDailyUsage": 45
}
This endpoint is crucial for adding new groups to the Plaspy application, allowing for better organization and management of devices by grouping them into named and described units.
- 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
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).