Class Manager
PUT /v1/locations/{id}

Update Location

Path parameters

  • id string Required

    Location id

application/json

Body

Request for creating/updating a new location

  • name string Required

    Name

Responses

  • 200 application/json

    successful operation

    Hide response attributes Show response attributes object
    • id string Required

      id

    • companyId string Required

      Company ID

    • name string Required

      Name

    • archivedAt string(date-time) | null Required

      Archived at date

    • createdAt string(date-time) Required

      Created at date
  • 403 application/json

    Not authorized

    Hide response attributes Show response attributes object

    Error schema

    • statusCode number Required

      Status Code

    • messages array[string] Required

      List of error messages

    • exception object

      Exception
  • 404 application/json

    Not found

    Hide response attributes Show response attributes object

    Error schema

    • statusCode number Required

      Status Code

    • messages array[string] Required

      List of error messages

    • exception object

      Exception
PUT /v1/locations/{id} 
curl \
 --request PUT 'https://localhost/v1/locations/loc_xxxxxxxx' \
 --header "Content-Type: application/json" \
 --data '{"name":"Main Studio"}'
Request examples 
{
  "name": "Main Studio"
}
Response examples (200) 
{
  "id": "loc_xxxxxxxxxxx",
  "companyId": "co_123123123123",
  "name": "Main Studio",
  "archivedAt": "2023-12-05 14:30:41",
  "createdAt": "2023-12-05 14:30:41"
}
Response examples (403) 
{
  "statusCode": 42.0,
  "messages": [
    "string"
  ],
  "exception": {}
}
Response examples (404) 
{
  "statusCode": 42.0,
  "messages": [
    "string"
  ],
  "exception": {}
}