Delete Unit Group

Beta

DELETE/v1/catalog/unit-groups/{id}

This endpoint is idempotent. Learn more

Deletes a unit group along with every unit association it contains.

The units themselves are not deleted and remain available to other groups. System unit groups, which are shared across all accounts, cannot be deleted.

Permissions requiredValues:unit_groups:delete

The role behind your API key or agent must grant every one of these permissions.

idstring

Unit group ID.

Responses

200

Successful response for Delete Unit Group

Delete Unit Group

import OpenMRP from '@openmrp/sdk';

const client = new OpenMRP({
  bearerToken: 'YOUR_API_KEY', // Your API key goes here
});

const unitGroup = await client.catalog.unitGroups.delete('ug_andst6m79n41');

console.log(unitGroup);

import OpenMRP from '@openmrp/sdk';

const client = new OpenMRP({
  bearerToken: 'YOUR_API_KEY', // Your API key goes here
});

const unitGroup = await client.catalog.unitGroups.delete('ug_andst6m79n41');

console.log(unitGroup);

200 example

{}

{}

Delete Unit Group

Authorization

Path Parameters

Responses