Delete group

DELETE

/groups/{groupId}

const url = 'https://api-uat.flinkey.de/v3/groups/1';
const options = {
  method: 'DELETE',
  headers: {
    'Customer-ID': 'example',
    'flinkey-API-Key': '<flinkey-API-Key>',
    Authorization: 'Bearer <token>'
  }
};

try {
  const response = await fetch(url, options);
  const data = await response.json();
  console.log(data);
} catch (error) {
  console.error(error);
}

curl --request DELETE \
  --url https://api-uat.flinkey.de/v3/groups/1 \
  --header 'Authorization: Bearer <token>' \
  --header 'Customer-ID: example' \
  --header 'flinkey-API-Key: <flinkey-API-Key>'

Purpose

Delete one specific group from 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 only when an existing group is no longer required and all relations to the group have already been removed.

When to use this operation

Use this operation when the partner backend or operational backend needs to delete a group.

Typical situations:

removing an obsolete operational group,
cleaning up test or setup groups,
deleting a group after migration or restructuring,
removing a wrongly created group,
cleaning up grouping structures after reconciliation.

Before deleting a group, the partner backend should have resolved:

the correct Customer-ID,
the flinkey groupId,
whether the group exists,
whether the group still has related cars,
whether the group still has related users,
whether the group still has related services,
whether the group still has related products.

A group cannot be deleted while relations to the group still exist.

Remove all relations to cars, users, services and products before deleting the group.

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

After all car, product, service and user relations had been removed, PROD returned 204 No Content with an empty body. A control GET /groups confirmed that the group was absent.

Async behavior

Synchronous.

The delete result is represented by the API response.

Webhook result

No.

This operation does not produce a webhook result.

Deleting a group does not replace assignment lifecycle operations.

If access permissions must be changed, use the appropriate assignment operations.

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

apiKey
bearerAuth

Parameters

Path Parameters

groupId

required

integer

Database ID of the group

Header Parameters

Customer-ID

required

string

Customer database ID

Responses

204

Group was deleted successfully

401

Invalid subscription key or missing / invalid access token

Recommended handling: Check flinkey-API-Key, bearer token and environment configuration

404

API Manager, customer context or group was not found

Recommended handling: Check credentials, token context, Customer-ID and local groupId mapping

409

Group could not be deleted because existing relations to the group still exist

Recommended handling: Remove all relations to the group and retry only after reconciliation

500

Server-side error

Recommended handling: Retry later if appropriate and escalate if persistent