Delete Gym

DELETE /gym/{gym_id}

Deletes whole gym along with all visits. Do not use this endpoint unless you are sure. You can only delete gym if you're admin.

Path parameters

gym_id integer Required

Id of the gym in database (retrieved using GET /gym)

Responses

200 application/json

Successful gym deletion.
Hide response attribute Show response attribute object
- success boolean
  
  Whether gym is deleted
400 application/json

Validation error of given input.
Hide response attributes Show response attributes object
- success boolean
  
  Whether query is successful
- error array[object]
  
  Validation error of given input.
  
  Hide error attributes Show error attributes object
  
  code string
  
  Error type
  
  expected string
  
  What was expected
  
  received string
  
  What's the error
  
  path array[string]
  
  What caused an error
  
  message string
  
  Error description
401 application/json

User is not unauthorized or permissions are missing.
Hide response attributes Show response attributes object
- success boolean
  
  Whether query is successful
- error string
  
  Error message
429 application/json

Rate limit exceeded - 100 queries per 15 minutes.
Hide response attributes Show response attributes object
- success boolean
  
  Whether query is successful
- error string
  
  Error message

DELETE /gym/{gym_id}

curl \
 --request DELETE 'http://63.141.232.244:25540/v0/gym/{gym_id}' \
 --header "Authorization: Bearer $ACCESS_TOKEN"

Response examples (200)

{
  "success": true
}

Response examples (400)

{
  "success": false,
  "error": [
    {
      "code": "invalid_type",
      "expected": "string",
      "received": "undefined",
      "path": [
        "client_id"
      ],
      "message": "Required"
    }
  ]
}

Response examples (401)

{
  "success": false,
  "error": "Unauthorized"
}

Response examples (429)

{
  "success": false,
  "error": "Too many requests, please try again later"
}