Delete a location

Request

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

A location with roles still recruiting at any of its venues cannot be deleted - remove or reassign those roles first. The same applies to the account's built-in default location, which is not removable at all.

The venues under it are not deleted, but they do become unreachable: every venue endpoint resolves a venue through its location, so once the location is gone its venues stop appearing in venue listings and can no longer be read, updated or removed. Move or delete the venues first if you need them to stay available.

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 location.

Rosterfy-Platformstring

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

Responses

Bodyapplication/json

messagesstring or null

Response

{
  "messages": null
}