POST /api/v1/gyms

Creates a new gym. This endpoint can be used by regular users to create their own gym, or by admins to create gyms for other users.

Permissions

Request Parameters

Request Example

{
  "name": "Iron Paradise",
  "address": "123 Main St",
  "location_lat": 35.6892,
  "location_lng": 51.3890,
  "is_active": true,
  "show_crowd": false,
  "description": "A premium gym with modern equipment.",
  "user_id": 42,
  "city_id": 5,
  "major_ids": "1,2,3"
}

Response

201 Created

Returns the created gym resource.

Schema

{
  "gym": { /* Gym Resource */ }
}

Example

{
  "gym": {
    "id": 123,
    "name": "Iron Paradise",
    "address": "123 Main St",
    "location_lat": 35.6892,
    "location_lng": 51.3890,
    "is_active": true,
    "description": "A premium gym with modern equipment.",
    "created_at": "2023-01-01 10:00:00",
    "updated_at": "2023-01-01 10:00:00",
    "show_crowd": false,
    "crowd": null,
    "city": {
      "id": 5,
      "name": "Tehran",
      "state": { /* State Resource */ }
    },
    "majors": [
      { "id": 1, "title": "Bodybuilding" },
      { "id": 2, "title": "Crossfit" }
    ],
    "working_periods": [
      {
        "id": 1,
        "gym_id": 123,
        "day": "monday",
        "gender": "women",
        "opens_at": "07:00",
        "closes_at": "23:30",
        "description": "Morning shift",
        "is_exception": false,
        "exception_start_date": null,
        "exception_end_date": null
      }
    ],
    "working_status": {
      "current": {
        "gender": "genderless",
        "opens_at": "08:30",
        "closes_at": "23:00"
      }
    },
    "boost": null,
    "media": [
      {
        "id": 10,
        "attachable_type": "App\\Models\\Gyms\\Gym",
        "attachable_id": 123,
        "link": "https://example.com/media/10.jpg"
      }
    ],
    "rating_count": 12,
    "rating_average": 4.5
  }
}

For a full schema, see Gym Resource.

Error Responses