Places

Add a place, and switch to it

The athlete is saying where they are now, so the new place becomes the active one — both surfaces that create a place are reached at the moment it is needed. The first place an athlete ever creates is also home. Names are unique per athlete (NAME_TAKEN, 409).

post/equipment/places

Request

  • Base URL: https://bodylab.lol/api/v1
  • URL: https://bodylab.lol/api/v1/equipment/places
  • Auth: HTTP bearer

Headers

X-Client-Platformstring

The native client's platform, e.g. ios. Server-side and non-native callers omit it.

X-Client-Versionstring

The native client's own semver version. With X-Client-Platform, a version below that platform's minimum is refused with CLIENT_UPGRADE_REQUIRED (426).

Request body

namestring nullable required

What to call it. Null only with justForToday: a one-off is never named.

itemsobject required

What is there. An empty object means nothing is, which is a real answer and is stored as one.

justForTodayboolean

True for somewhere the athlete will not go again: it becomes active for today and reverts to home tomorrow, and it is never listed. Creating another replaces it, so retrying is safe. False (the default) creates a place that is listed and holds until the athlete switches.

Response

OK

idstring required

Opaque identifier.

namestring nullable required

What the athlete called it. Null for the unnamed one-off in force today (see justForToday): it has no name because it is never listed and never chosen again.

itemsobject required

What is at this place, each item mapping to the heaviest single implement of it in kilograms, or null for "enough" (a rack needs no number). Absent keys are not there. An empty object is a real place — a hotel room with nothing in it — and not a place with no answer.

isHomeboolean required

The place everything reverts to: exactly one of the athlete's places is home. It can't be deleted while another place exists — make another one home first.

isActiveboolean required

True for the one place every prescription is currently written from. Exactly one place is active, and it stays active until the athlete switches.

forDatestring date nullable required

A day on the athlete's own calendar: YYYY-MM-DD, no time zone.

createdAtstring date-time required

An instant: ISO-8601 with offset, e.g. 2026-09-13T06:30:00Z.

updatedAtstring date-time required

An instant: ISO-8601 with offset, e.g. 2026-09-13T06:30:00Z.

Changes

No recorded changes to this operation across all 1 revision of this API.