How to Enable Whiteboard in Digital Samba via the API

1 min read
November 1, 2023

With Digital Samba you can enable the whiteboard functionality and permission using the dashboard or through our API. To do so, follow the steps below.

To enable the whiteboard room feature using Digital Samba's API, you'll need to set the whiteboard property to true through a PATCH request, which edits the room properties. It can also be enabled through POST requests during room creation. Here's a detailed step-by-step guide on how to do it:

  1. API Endpoint: To edit room features, make a PATCH request to:

https://api.digitalsamba.com/api/v1/rooms/{room_id}

  1. Request Payload: To enable the Whiteboard, in the request body set the whiteboard_enabled to true. For example:
{
"whiteboard_enabled": true
}
  1. Send the Request: Make the PATCH request to the endpoint with the room ID and payload to update the room.
  2. Check the Response: You should receive a 200 OK response if the whiteboard was enabled successfully.
  3. Confirm in Dashboard: Go to your Digital Samba dashboard or execute a GET request for the room to confirm the whiteboard is now enabled.

Here is an example of a curl command that you can use to enable the whiteboard room feature for a room with the ID 12345:

curl -X PATCH \

-H "Authorization: Basic {API_KEY}" \

-H "Content-Type: application/json" \

-d '{

"whiteboard_enabled": true

}

}'

https://api.digitalsamba.com/api/v1/rooms/12345

For more detailed information and other available properties, please refer to the official Digital Samba REST API documentation. Always use secure methods when making API requests, and include your credentials in the authorization header to avoid unauthorized responses.

Wrap up

Transform your software applications and boost user satisfaction by embedding Digital Samba's cutting-edge whiteboard and video conferencing capabilities, delivering an unparalleled level of interaction and productivity to your customers.

Sign up to Digital Samba for free or talk to our sales team about embedding video conferencing empowered with a whiteboard to your software or app.

Request a free consultation with our dev team
Enable whiteboard in Digital Samba via the API
Get a consultation

 

Get Email Notifications