Update a location

Request

Updates the fields supplied and returns the location in the same shape as reading it. Only the fields sent are touched, so an empty body is a valid request that changes nothing.

Renaming a location does not affect the venues under it or the roles advertised at those venues.

Security

default

Path

idintegerrequired

The ID of the location.

Rosterfy-Platformstring

Bodyapplication/json

namestring

The name administrators see. Required.

frontend_namestring

The name volunteers see in the portal. Required, and shown in place of name to anyone without administrator access, so it is worth setting even when the two match.

codestring

A short reference for the location, unique within the account regardless of case. Letters, numbers, dashes and underscores only - spaces and punctuation are rejected. Stored and returned in upper case whatever case it is sent in.

headcount_location_type_idinteger

The ID of the location type to file this location under. Optional; omit or send null to leave the location untyped. Must be the ID of a type the account holds.

training_idsArray of integers

The IDs of the training modules assigned to anyone who accepts a role at this location. Replaces the whole list rather than adding to it, so send every module you want kept. Omitting the field leaves the stored list untouched.

curl -i -X PUT \
  'https://developer.rosterfy.com/_mock/api-docs/openapi/api/v2/headcount/location/{id}' \
  -H 'Authorization: Bearer <YOUR_TOKEN_HERE>' \
  -H 'Content-Type: application/json' \
  -H 'Rosterfy-Platform: admin' \
  -d '{
    "name": "Main Campus",
    "frontend_name": "Main Campus",
    "code": "MAINCAMPUS",
    "headcount_location_type_id": 1,
    "training_ids": [
      1
    ]
  }'

Responses

Bodyapplication/json

objectobject

niceobject

relationsobject

permissionsobject

Response

{
  "object": {
    "id": 1,
    "account_id": 20101,
    "headcount_location_type_id": 1,
    "name": "Main Campus",
    "frontend_name": "Main Campus",
    "code": "MAINCAMPUS",
    "training_ids": [ … ],
    "is_system": 0,
    "deleted_at": null,
    "created_at": "2026-06-09T05:36:16.000000Z",
    "updated_at": "2026-06-09T05:36:16.000000Z",
    "uuid": "ec98790e-5bab-4ad7-9357-31556e2efbc4"
  },
  "nice": {
    "rrn": "rrn:local:20101:location:1",
    "headcount_location_type_name": "Stadium"
  },
  "relations": {
    "headcount_location_type": { … }
  },
  "permissions": {
    "read": true,
    "update": true,
    "delete": true
  }
}