Skip to content

Delete a functional area

Request

Removes the group. The record is retained internally so past reporting is not lost, but the group can no longer be read or edited and no endpoint restores it.

A group that still has roles recruiting under it cannot be deleted - remove or reassign its roles first. The same applies to the account's built-in default group, which is not removable at all.

Returns 200 with a messages field rather than an empty 204. messages carries anything the platform wants to tell you about the deletion and is null when there is nothing to say.

Security
default
Path
idintegerrequired

The ID of the functional area.

Headers
Rosterfy-Platformstring
curl -i -X DELETE \
  'https://developer.rosterfy.com/_mock/api-docs/openapi/api/v2/headcount/functionalarea/{id}' \
  -H 'Authorization: Bearer <YOUR_TOKEN_HERE>' \
  -H 'Rosterfy-Platform: admin'

Responses

Bodyapplication/json
messagesstring or null
Response
{ "messages": null }