API

Update a custom role

PUT /v1/spotMemberCustomRole/{customRoleId}

Update a custom role

Path parameters

  • customRoleId string Required

    The id of the custom role

application/json

Body Required

  • label string

    The label of the custom role.

  • description string

    The description of the custom role.

  • permissions array[string]

    The permissions of the custom role.

    Values are live.*, live.full.*, live.limited.*, moderation.*, spot.member.invite.*, course.limited.*, course.full.*, collection.full.*, or collection.limited.*.

Responses

  • 200 application/json

    Custom role successfully updated

    Hide response attributes Show response attributes object
    • id string Required

      The id of the custom role.

    • label string Required

      The label of the custom role.

    • description string Required

      The description of the custom role.

    • permissions array[string] Required

      The permissions of the custom role.

      Values are live.*, live.full.*, live.limited.*, moderation.*, spot.member.invite.*, course.limited.*, course.full.*, collection.full.*, or collection.limited.*.
  • 400

    Malformed payload

  • 404

    Custom role not found

PUT /v1/spotMemberCustomRole/{customRoleId} 
curl \
 --request PUT 'https://openapi.meltingspot.io/v1/spotMemberCustomRole/{customRoleId}' \
 --header "Content-Type: application/json" \
 --data '{"label":"string","description":"string","permissions":["live.*"]}'
Request examples 
{
  "label": "string",
  "description": "string",
  "permissions": [
    "live.*"
  ]
}
Response examples (200) 
{
  "id": "string",
  "label": "string",
  "description": "string",
  "permissions": [
    "live.*"
  ]
}