PATCH /api/groups/{groupId}
This endpoint allows you to partially update the details of an existing group using its unique identifier (groupId). It is useful for modifying one or more attributes of a group without needing to send all the group's data.
Request Details
To partially update a group, you must send a PATCH request with the patch operations in the request body. Ensure the request is authorized with a valid token and that the group's identifier (groupId) is correct.
Request Parameters
Path Parameters
| Field | Type | Required | Description |
|---|---|---|---|
| groupId | string | Yes | Unique identifier of the group to update |
Request Body Parameters
The request body must include a list of patch operations to perform on the group. Each operation follows the JSON Patch format.
| Field | Type | Required | Description |
|---|---|---|---|
| op | string | Yes | Operation to perform (e.g., "add", "remove", "replace"). |
| path | string | Yes | Path to the group attribute to modify (e.g., "/name", "/description"). |
| value | object | No | New value for the attribute specified in path. Required if op is "add" or "replace". |
Example Request Body
[
{
"op": "replace",
"path": "/name",
"value": "Updated Name"
},
{
"op": "replace",
"path": "/description",
"value": "Updated description of the group"
}
]
Authentication Required
Authentication required to use the endpoint is via a Bearer token. This authentication method implies that each request must include an authorization header with a valid access token. This Bearer token acts as a credential that verifies the identity of the user or application making the request, ensuring that only authorized entities can modify the user's information. By requiring this type of authentication, the system guarantees a high level of security and access control, protecting users' data against unauthorized access.
Example Request
PATCH /api/groups/grp-125 HTTP/1.1
Host: api.plaspy.com
Authorization: Bearer eyJhbGciOiJIUzUxMiIsInR5cCI6IkpXV...
Content-Type: application/json
[
{
"op": "replace",
"path": "/name",
"value": "Updated Name"
},
{
"op": "replace",
"path": "/description",
"value": "Updated description of the group"
}
]
Response Parameters
The response includes details of the updated 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 updated 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": "Updated Name",
"description": "Updated description of the group",
"devices": ["dev-123", "dev-456"],
"creation": "2023-01-01T12:00:00Z",
"lastModified": "2023-06-01T12:00:00Z"
}
Example Error Response
{
"success": false,
"error": "Group not found",
"apiUsage": 123,
"apiDailyUsage": 45
}
This endpoint is essential for making partial updates to group information in the application, allowing specific modifications without needing to send all the group's data.
Plaspy GPS Tracking Platform
Explore the Plaspy platform and compatible GPS devices
Browse technical guides, application documentation, compatible trackers, and setup resources to get more value from Plaspy.