DELETE
/api/public/v1/benefits/{benefitId}

Delete a benefit

Removes it from the catalog, and every enrollment in it with it. There is no restore — this one is not soft.

Required scope

The access token must carry this scope. A token missing it gets 403 Forbidden. Grant them to an API client under Settings → Company → API, and to a teammate under Employee → Permissions.

hr:write

Path Parameters

NameTypeRequiredDescription
benefitIdstringRequiredBenefit ID.
DELETEExample request
curl
curl -X DELETE "https://www.pxb.app/api/public/v1/benefits/{benefitId}" \
  -H "Authorization: Bearer your_access_token"
200Example response
json
{
  "message": "Benefit deleted successfully!",
  "content": {
    "benefitId": "ben_08de"
  }
}

In the console

The same thing done by hand, for anyone comparing the API against the screen they already use.

Employees → Benefits
/employee/benefits