Update group
const url = 'https://api-uat.flinkey.de/v3/groups/1';const options = { method: 'PATCH', headers: { 'Customer-ID': 'example', 'flinkey-API-Key': '<flinkey-API-Key>', Authorization: 'Bearer <token>', 'Content-Type': 'application/json-patch+json' }, body: '[ { "op": "replace", "path": "/name", "value": "Fleet Berlin" } ]'};
try { const response = await fetch(url, options); const data = await response.json(); console.log(data);} catch (error) { console.error(error);}curl --request PATCH \ --url https://api-uat.flinkey.de/v3/groups/1 \ --header 'Authorization: Bearer <token>' \ --header 'Content-Type: application/json-patch+json' \ --header 'Customer-ID: example' \ --header 'flinkey-API-Key: <flinkey-API-Key>' \ --data '[ { "op": "replace", "path": "/name", "value": "Fleet Berlin" } ]'Purpose
Update the name of one specific group in the selected customer context.
A group is an entity represented by a group ID.
A group can contain cars, users, services and products.
Use this operation for operational grouping workflows where an existing group must be renamed.
When to use this operation
Use this operation when the partner backend or operational backend needs to update a group name.
Typical situations:
- renaming an operational group,
- correcting a group name,
- aligning group names with partner-side structures,
- maintaining group-based administration workflows,
- updating group names after customer-side naming changes,
- cleaning up group names after reconciliation.
Before updating a group, the partner backend should have resolved:
- the correct
Customer-ID, - the flinkey
groupId, - the intended new group name,
- whether the group exists,
- whether the new name is valid,
- whether the new name would conflict with operational naming rules.
For standard access flows, partner backends usually work primarily with Car, User and Assignment.
Group membership is an operational grouping concept and should not be treated as the primary vehicle access permission.
Validation notes
PATCH /groups/{groupId}with a JSON Patchreplaceoperation for/namereturned204 No Content.Content-Type: application/json-patch+jsonwas accepted and is the validated media type.- The renamed group was retrieved through
GET /groups; the group ID remained unchanged.
Async behavior
Synchronous.
The group update result is represented by the API response.
Webhook result
No.
This operation does not produce a webhook result.
Security notes
Never log:
flinkey-API-Key,- bearer token,
- full request headers.
Group identifiers are environment-specific.
Do not mix UAT and PROD group IDs.
Use placeholders in documentation, examples, screenshots and AI prompts.
For standard partner integrations, the mobile app must not receive API Manager credentials, backend bearer tokens or the flinkey-API-Key.
Authorizations
Section titled “Authorizations”Parameters
Section titled “Parameters”Path Parameters
Section titled “Path Parameters”Database ID of the group
Header Parameters
Section titled “Header Parameters”Customer database ID
Request Bodyrequired
Section titled “Request Bodyrequired”object
Operation to perform. Documented value: replace
Field to update. Documented value: /name
New group name
Example
[ { "op": "replace", "path": "/name", "value": "Fleet Berlin" }]Responses
Section titled “Responses”Group was updated successfully
Group name is null, empty, whitespace or longer than the allowed maximum length
Recommended handling: Validate the new group name before sending the request
Invalid subscription key or missing / invalid access token
Recommended handling: Check flinkey-API-Key, bearer token and environment configuration
API Manager, customer context or group was not found
Recommended handling: Check credentials, token context, Customer-ID and local groupId mapping
Request content type is missing or incorrect
Recommended handling: Ensure Content-Type: application/json-patch+json is used
Server-side error
Recommended handling: Retry later if appropriate and escalate if persistent