API

Update a spot

PUT /v1/spots/{spotId}

Update a spot

Path parameters

  • spotId string Required

    The id of the spot

application/json

Body Required

  • name string

    Name of the spot

  • description string

    Description of the spot

  • privacy string

    Privacy setting of the spot

    Values are Public or Private.

  • spotModuleConfigs array[object]

    Configurations of the spot modules

    Hide spotModuleConfigs attributes Show spotModuleConfigs attributes object
    • type string Required

      Type of the spot module configuration

      Values are SpotHomePage, LearningPaths, Lives, Courses, Channels, Collections, or MemberDirectory.

    • enabled boolean Required

      Indicates if the module is enabled

    • id string Required

      ID of the spot module configuration

  • lang string

    Language of the spot

    Values are en, fr, de, it, es, pt, or nl.

  • theme object

    Theme of the spot

    Hide theme attributes Show theme attributes object
    • fonts object | null

      Fonts of the theme

    • palettes object | null

      Palettes of the theme in hex format (#FFFFFF)

Responses

  • 200 application/json

    The spot has been successfully updated.

    Hide response attributes Show response attributes object
    • id string Required

      The id of the spot.

    • name string Required

      The name of the spot.

    • description string Required

      The description of the spot.

    • privacy string Required

      The privacy of the spot.

      Values are Public or Private.

    • ownerId string Required

      The ownerId of the spot. Corresponds to the userId of the user who created the spot.
  • 400

    Malformed payload

  • 404

    Spot not found

PUT /v1/spots/{spotId} 
curl \
 --request PUT 'https://openapi.meltingspot.io/v1/spots/{spotId}' \
 --header "Content-Type: application/json" \
 --data '{"name":"string","description":"string","privacy":"Public","spotModuleConfigs":[{"type":"SpotHomePage","enabled":true,"id":"string"}],"lang":"en","theme":{"fonts":{},"palettes":{}}}'
Request examples 
{
  "name": "string",
  "description": "string",
  "privacy": "Public",
  "spotModuleConfigs": [
    {
      "type": "SpotHomePage",
      "enabled": true,
      "id": "string"
    }
  ],
  "lang": "en",
  "theme": {
    "fonts": {},
    "palettes": {}
  }
}
Response examples (200) 
{
  "id": "string",
  "name": "string",
  "description": "string",
  "privacy": "Public",
  "ownerId": "string"
}