Create
Last updated
Last updated
To create a new role you need to execute a POST request against the /roles endpoint.
The following fields need to be set:
name -> internal unique name to reference the role in and
display_name -> the display name people will see visually inside the participants list
permissions -> a JSON object of the this role is allowed to have. Allowed permissions have true as a value. For role sensitive permissions like remote_muting you can additionally specify an array with the role names which the participant is allowed to operate on. For example you can make a Speaker be allowed to remote mute an Attendee, but not remote mute a Moderator. If you don't specify the array (and just put true), that means the participant is allowed to operate on all roles (current and future). That gives you full flexibility.
description (optional) -> text description if you want to add some explanations
Creating a role doesn't immediately assign it to any rooms. You need to specify the available roles inside a room during . If all of your rooms will have the same roles it may be easier for you to set these roles in the default , so all rooms will inherit the same default roles.