Create a location

Request

Sets up a new place to recruit and roster people to. Venues are then created under it, and roles are advertised against those venues rather than against the location itself.

code has to be unique within the account and is stored in upper case whatever case it is sent in, so mainstadium and MAINSTADIUM are the same code.

The created location comes back with only the fields that were set on it, not the full record that reading it returns: anything left to its stored default is absent rather than present and defaulted. Read the location back if you need its complete state.

Security

default

Rosterfy-Platformstring

Bodyapplication/jsonrequired

namestringrequired

The name administrators see. Required.

frontend_namestringrequired

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.

codestringrequired

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 POST \
  https://developer.rosterfy.com/_mock/api-docs/openapi/api/v2/headcount/location \
  -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": {
    "name": "Main Campus",
    "frontend_name": "Main Campus",
    "headcount_location_type_id": 1,
    "code": "MAINCAMPUS",
    "training_ids": [ … ],
    "account_id": 20101,
    "uuid": "ec98790e-5bab-4ad7-9357-31556e2efbc4",
    "updated_at": "2026-06-09T05:36:16.000000Z",
    "created_at": "2026-06-09T05:36:16.000000Z",
    "id": 1
  },
  "nice": {
    "rrn": "rrn:local:20101:location:1",
    "headcount_location_type_name": "Stadium"
  },
  "relations": {
    "headcount_location_type": { … }
  },
  "permissions": {
    "read": true,
    "update": true,
    "delete": true
  }
}