{"openapi":"3.0.0","info":{"title":"Whiteboard","description":"The [Zoom Whiteboard APIs](https://developers.zoom.us/docs/zoom-whiteboard/) allow you to manage your Zoom Whiteboard. For example, collaborative persistent whiteboard that allows participants to share and collaborate on a virtual whiteboard in real time The Zoom Whiteboard REST API for [Zoom Whiteboard](https://developers.zoom.us/docs/api/rest/whiteboard/) allows developers to interact with various Zoom features, including Zoom Whiteboard. Developers can create and manage whiteboards programmatically using these APIs.","termsOfService":"https://zoom.us/docs/en-us/zoom_api_license_and_tou.html","contact":{"name":"Zoom Developers","url":"https://developer.zoom.us/"},"version":"2"},"externalDocs":{"description":"Find out more about Swagger","url":"https://swagger.io"},"servers":[{"url":"https://api.zoom.us/v2"}],"paths":{"/whiteboards/sessions":{"get":{"tags":["Archiving"],"summary":"List whiteboards sessions","description":"Creates a list of archived sessions under current account.\n\n**[Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `whiteboard_content:read`,`whiteboard_content:read:admin`\n\n**[Granular Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `whiteboard:read:list_sessions`,`whiteboard:read:list_sessions:admin`\n\n**[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `MEDIUM`","operationId":"Createwhiteboardsarchivefiles","parameters":[{"name":"page_size","in":"query","description":"The number of records returned within a single API call.","required":false,"schema":{"maximum":300,"type":"integer","example":30,"default":30}},{"name":"next_page_token","in":"query","description":"The next page token paginates through a large set of results. A next page token returns whenever the set of available results exceeds the current page size. The expiration period for this token is 15 minutes.","required":false,"schema":{"type":"string","example":"IAfJX3jsOLW7w3dokmFl84zOa0MAVGyMEB2"}},{"name":"from","in":"query","description":"The query session `start_time `date in` yyyy-MM-dd'T'HH:mm:ssZ` format. The `start_time` of a session in the result list should be greater than or equal to `from`. If this field has no provided value, the default is the current date. For example, if you make the API request on June 30, 2020, without providing the `from` and `to` parameters, by default, the value of the `from` field will be “2020-06-30,” and the value of the `to` field will be “2020-07-30”.","required":false,"schema":{"type":"string","format":"date-time","example":"2021-03-12T02:12:27Z"}},{"name":"to","in":"query","description":"The query session`end_time` date, in `yyyy-MM-dd'T'HH:mm:ssZ` format. The `end_time` of session in result list should be less than or equal to `to`.","required":false,"schema":{"type":"string","format":"date-time","example":"2021-03-18T05:41:36Z"}}],"responses":{"200":{"description":"The returned archived sessions list.","content":{"application/json":{"schema":{"required":["from","next_page_token","page_size","to"],"type":"object","properties":{"from":{"type":"string","description":"The queried start date.","format":"date-time","example":"2021-03-12T02:12:27Z"},"to":{"type":"string","description":"The queried end date.","format":"date-time","example":"2021-03-12T02:12:27Z"},"page_size":{"maximum":300,"type":"integer","description":"The number of records returned per page in a single API call.","example":30,"default":30},"next_page_token":{"type":"string","description":"The next page token paginates through a large set of results. A next page token returns whenever the set of available results exceeds the current page size. The expiration period for this token is 15 minutes.\n\nNote: If you use `next_page_token` as a parameter, your other request parameters should be changeless to make sure that the large result set is what you want. For example, if your to parameter is for a future time, Zoom resets this value to the current time and returns this value in the response body, along with the `next_page_token` value. Use these same to and `next_page_token` values in requests for the remaining results set; otherwise you will get an invalid token error.","example":"IAfJX3jsOLW7w3dokmFl84zOa0MAVGyMEB2"},"sessions":{"maxItems":300,"type":"array","description":"The whiteboard archived sessions list. ","items":{"type":"object","properties":{"id":{"type":"string","description":"The session's unique ID.","example":"a2f19f96-9294-4f51-8134-6f0eea108eb2"},"start_time":{"type":"string","description":"The session's start time.\nIt should be `from < start_time`","format":"date-time","example":"2021-03-11T05:41:36Z"},"end_time":{"type":"string","description":"The session's end time.\nIt should be `end_time < to`","format":"date-time","example":"2021-03-11T05:41:36Z"},"whiteboard_id":{"type":"string","description":"The ID of whiteboard.","example":"HY8-AC_HSou4SXY1S-OmOg"},"whiteboard_name":{"type":"string","description":"The name of whiteboard.","example":"example_whiteboard_name"},"expire_time":{"type":"string","description":"The session's expire time. ","format":"date-time","example":"2021-03-26T06:41:36Z"},"regulated_participants":{"maxItems":1000,"type":"array","description":"The session participant under this account.","items":{"type":"object","properties":{"user_id":{"type":"string","description":"The unique ID of participant user in this session.","example":"wf3h7uo1dk0v53bl"},"user_name":{"type":"string","description":"The name of participant user in this session.","example":"Jack"},"join_whiteboard_time":{"type":"string","description":"The user join the whiteboard time.","format":"date-time","example":"2021-03-26T06:41:36Z"},"leave_whiteboard_time":{"type":"string","description":"The user leave the whiteboard time.","format":"date-time","example":"2021-03-26T07:41:36Z"},"email":{"type":"string","description":"The email of participant. `nullable` If the participant is not part of the session's account, this returns an empty string value.","example":"user@example.com"}},"description":"The regulated user info under the account"}}}}},"total_records":{"type":"integer","description":"The total number of returned sessions records.","example":20}}}}}},"400":{"description":"**HTTP Status Code:** `400` <br>\n Bad Request  \n\n **Error Code:** `34002` <br>\n Invalid parameter. <br>\n"},"429":{"description":"**HTTP Status Code:** `429` <br>\n Too Many Requests. For more information, see [rate limits](https://developers.zoom.us/docs/api/rest/rate-limits/). \n\n "}},"security":[{"openapi_oauth":["whiteboard_content:read","whiteboard_content:read:admin","whiteboard:read:list_sessions","whiteboard:read:list_sessions:admin"],"openapi_authorization":[]}],"x-extensions":{"x-permissions":["WhiteboardContent:Read"],"x-macro-scopes":["whiteboard_content:read","whiteboard_content:read:admin"],"x-granular-scopes":["whiteboard:read:list_sessions","whiteboard:read:list_sessions:admin"]}}},"/whiteboards/sessions/activity/download/{path}":{"get":{"tags":["Archiving"],"summary":"Download Whiteboards activity file","description":"Use this API to download the Whiteboard archival file. For obtaining the download URL, please consult the [List whiteboard sessions activities](https://developers.zoom.us/docs/api/rest/reference/whiteboard/methods/#operation/Listwhiteboardsessionsarchivedfiles) documentation. Scroll down under field on schema to documentation URL string.\n\n**[Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `whiteboard_content:read`,`whiteboard_content:read:admin`\n\n**[Granular Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `whiteboard:read:archived_file`,`whiteboard:read:archived_file:admin`\n\n**[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `MEDIUM`","operationId":"Downloadwhiteboardsactivityfile","parameters":[{"name":"path","in":"path","description":"The file path.","required":true,"schema":{"type":"string","example":"Qg75t7xZBtEbAkjdlgbfdngBBBB"}}],"responses":{"200":{"description":"Returns a file stream.","headers":{"Content-Type":{"description":"Content-Type.","required":false,"schema":{"type":"string","example":"application/octet-stream"}},"Content-Disposition":{"description":"Content-Disposition.","required":false,"schema":{"type":"string","example":"attachment;filename=adcc655d3a3549e692959737fe2a7a0d.pdf"}},"Content-Length":{"description":"Content-Length.","required":false,"schema":{"type":"string","example":"102400"}}}},"400":{"description":"**HTTP Status Code:** `400` <br>\n Bad Request  \n\n **Error Code:** `34002` <br>\n Invalid path. <br>\n"},"404":{"description":"**HTTP Status Code:** `404` <br>\n Not Found  \n\n **Error Code:** `34000` <br>\n The resource not found. The file does not exist or the file has expired. <br>\n"},"429":{"description":"**HTTP Status Code:** `429` <br>\n Too Many Requests. For more information, see [rate limits](https://developers.zoom.us/docs/api/rest/rate-limits/). \n\n "}},"security":[{"openapi_oauth":["whiteboard_content:read","whiteboard_content:read:admin","whiteboard:read:archived_file","whiteboard:read:archived_file:admin"],"openapi_authorization":[]}],"x-extensions":{"x-permissions":["WhiteboardContent:Read"],"x-macro-scopes":["whiteboard_content:read","whiteboard_content:read:admin"],"x-granular-scopes":["whiteboard:read:archived_file","whiteboard:read:archived_file:admin"]}}},"/whiteboards/sessions/{seesionId}":{"get":{"tags":["Archiving"],"summary":"List whiteboard sessions activities","description":"Lists a session's activity information.\n\n**[Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `whiteboard_content:read`,`whiteboard_content:read:admin`\n\n**[Granular Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `whiteboard:read:session`,`whiteboard:read:session:admin`\n\n**[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `MEDIUM`","operationId":"Listwhiteboardsessionsarchivedfiles","parameters":[{"name":"seesionId","in":"path","description":"The session unique ID.\n","required":true,"schema":{"type":"string","example":"f8b9197a-0c8f-c8de-4db3-d8a5e8d9f505"}},{"name":"page_size","in":"query","description":"The number of records returned within a single API call.","required":false,"schema":{"maximum":300,"type":"integer","example":30,"default":30}},{"name":"next_page_token","in":"query","description":"The next page token paginates through a large set of results. A next page token returns whenever the set of available results exceeds the current page size. The expiration period for this token is 15 minutes.","required":false,"schema":{"type":"string","example":"IAfJX3jsOLW7w3dokmFl84zOa0MAVGyMEB2"}}],"responses":{"200":{"description":"The session activity information.","content":{"application/json":{"schema":{"required":["page_size","total_records"],"type":"object","properties":{"page_size":{"type":"integer","description":"The number of records returned within a single API call.","example":30},"next_page_token":{"type":"string","description":"The next page token paginates through a large set of results. A next page token returns whenever the set of available results exceeds the current page size. The expiration period for this token is 15 minutes. **Note**: if you use `next_page_token` as a parameter, your other request parameters should be changeless to make sure that the large result set is what you want. For example, if your to parameter is for a future time, Zoom resets this value to the current time and returns this value in the response body, along with the `next_page_token` value. Use these same to and `next_page_token` values in requests for the remaining results set; otherwise you will get an invalid token error.","example":"IAfJX3jsOLW7w3dokmFl84zOa0MAVGyMEB2"},"session_id":{"type":"string","description":"The unique ID of current session.","example":"a2f19f96-9294-4f51-8134-6f0eea108eb2"},"whiteboard_id":{"type":"string","description":"The ID of the Zoom Whiteboard.","example":"HY8-AC_HSou4SXY1S-OmOg"},"whiteboard_name":{"type":"string","description":"The name of Zoom Whiteboard.","example":"example_whiteboard_name"},"start_time":{"type":"string","description":"The session's start time.","format":"date-time","example":"2021-03-11T05:41:36Z"},"end_time":{"type":"string","description":"The session's end time.","format":"date-time","example":"2021-03-11T06:41:36Z"},"expire_time":{"type":"string","description":"The session's expire time. ","format":"date-time","example":"2021-03-26T06:41:36Z"},"activities":{"maxItems":300,"type":"array","description":"The activity list of a session.","items":{"type":"object","properties":{"id":{"type":"string","description":"The unique ID of an activity.","example":"cc63bce7-cb59-c1dc-fadd-2be734ad1d55"},"type":{"type":"string","description":"The operation description.","example":"add object"},"download_url":{"type":"string","description":" The URL to download the the archive file. OAuth apps If a user has authorized and installed your OAuth app that contains `whiteboard:read:archived_file` or `whiteboard:read:archived_file:admin` scopes, use the user's [OAuth access token](https://developers.zoom.us/docs/integrations/oauth/) to download the file. More details refer [Download Whiteboards activity file](https://developers.zoom.us/docs/api/rest/reference/whiteboard/methods/#operation/Downloadwhiteboardsactivityfile)\n For example:  `https://{{base-domain}}/whiteboards/sesssions/activity/download/xxx--header 'Authorization: Bearer {{OAuth-access-token}}'`","example":"https://example.com/whiteboards/sessions/activity/download/Qg75t7xZBtEbAkjdlgbfdngBBBB"},"create_time":{"type":"string","description":"The activity create time.","format":"date-time","example":"2021-03-11T05:41:36Z"},"user_id":{"type":"string","description":"The ID of user. `nullable`  If the participant is **not** part of the session's account, this returns an empty string value.","example":"wf3h7uo1dk0v53bl"},"collaborator_id":{"type":"string","description":"The participant's unique ID. `not nullable` ","example":"x4g6hy789k0o878k"},"collaborator_name":{"type":"string","description":"The participant's display name.","example":"Jack"},"email":{"type":"string","description":"The email of participant. `nullable` If the participant is not part of the session's account, this returns an empty string value.","example":"user@example.com"},"content":{"type":"string","description":"The text content generated by the activity.","example":"This is a activity content demo"},"object_ids":{"maxItems":100,"minItems":0,"type":"array","description":"The IDs of the whiteboard object associated with this activity.","items":{"type":"string","description":"The object ID in the whiteboard.","example":"wfx4g6s1dk0v53bl"}}},"description":"activity information"}},"total_records":{"type":"number","description":"The total number of returned activities records.","example":30}}}}}},"400":{"description":"**HTTP Status Code:** `400` <br>\n Bad Request  \n\n "},"404":{"description":"**HTTP Status Code:** `404` <br>\n Not Found  \n\n **Error Code:** `34000` <br>\n The session not exist or expired. <br>\n"},"429":{"description":"**HTTP Status Code:** `429` <br>\n Too Many Requests. For more information, see [rate limits](https://developers.zoom.us/docs/api/rest/rate-limits/). \n\n "}},"security":[{"openapi_oauth":["whiteboard_content:read","whiteboard_content:read:admin","whiteboard:read:session","whiteboard:read:session:admin"],"openapi_authorization":[]}],"x-extensions":{"x-permissions":["WhiteboardContent:Read"],"x-macro-scopes":["whiteboard_content:read","whiteboard_content:read:admin"],"x-granular-scopes":["whiteboard:read:session","whiteboard:read:session:admin"]}}},"/whiteboards/classification_labels":{"get":{"tags":["Classification Labels"],"summary":"List classification labels","description":"Retrieves all classification labels for the account.\n\n**Note:** Each account can have a maximum of 30 classification labels. The `whiteboard_count` field is only returned when using admin scopes.\n\n**[Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `whiteboard_classification_labels:read:admin`,`whiteboard_classification_labels:read`\n\n**[Granular Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `whiteboard:read:list_classification_labels:admin`,`whiteboard:read:list_classification_labels`\n\n**[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `LIGHT`","operationId":"listClassificationLabels","responses":{"200":{"description":"Classification labels retrieved successfully.","content":{"application/json":{"schema":{"type":"object","properties":{"labels":{"type":"array","description":"List of classification labels.","items":{"type":"object","properties":{"classification_id":{"type":"string","description":"The unique identifier of the classification label to apply.","example":"abc123xyz"},"name":{"type":"string","description":"The display name of the classification label","example":"Confidential"},"description":{"type":"string","description":"A description of the classification label","example":"For internal use only"},"color":{"type":"string","description":"The hex color code for the label","example":"#FF5733"},"sensitivity_level":{"maximum":5,"minimum":1,"type":"integer","description":"The sensitivity rank of the label.","example":5},"guideline_url":{"type":"string","description":"URL to the classification guidelines document","example":"https://example.com/guidelines"},"is_default":{"type":"boolean","description":"Whether this is the default label for new whiteboards","example":false},"create_time":{"type":"string","description":"The timestamp when the label was created","format":"date-time","example":"2026-01-29T10:30:00Z"},"modify_time":{"type":"string","description":"The timestamp when the label was last modified","format":"date-time","example":"2026-01-29T10:30:00Z"},"whiteboard_count":{"type":"integer","description":"The number of whiteboards using this classification label (only returned when using admin scopes).","example":15}}}},"total_records":{"type":"integer","description":"The total number of classification labels.","example":5}}}}}},"403":{"description":"**HTTP Status Code:** `403` <br>\n Forbidden  \n\n **Error Code:** `34004` <br>\n Feature not enabled. Data classification feature is not enabled for this account. <br>\n"},"429":{"description":"**HTTP Status Code:** `429` <br>\n Too Many Requests. For more information, see [rate limits](https://developers.zoom.us/docs/api/rate-limits/). \n\n "}},"security":[{"openapi_oauth":["whiteboard_classification_labels:read:admin","whiteboard_classification_labels:read","whiteboard:read:list_classification_labels:admin","whiteboard:read:list_classification_labels"],"openapi_authorization":[]}],"x-extensions":{"x-permissions":["WhiteboardManagement:Read"],"x-macro-scopes":["whiteboard_classification_labels:read:admin","whiteboard_classification_labels:read"],"x-granular-scopes":["whiteboard:read:list_classification_labels:admin","whiteboard:read:list_classification_labels"]}},"post":{"tags":["Classification Labels"],"summary":"Create a classification label","description":"Creates a new classification label for the account. The label is immediately available for use.\n\n**Note:** Each account can have a maximum of 30 classification labels.\n\n**[Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `whiteboard_classification_labels:write:admin`\n\n**[Granular Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `whiteboard:write:classification_labels:admin`\n\n**[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `LIGHT`","operationId":"createClassificationLabel","requestBody":{"content":{"application/json":{"schema":{"required":["color","name","sensitivity_level"],"type":"object","properties":{"name":{"maxLength":30,"type":"string","description":"The display name of the classification label.","example":"Confidential"},"description":{"maxLength":1000,"type":"string","description":"A description of the classification label.","example":"For internal use only"},"color":{"pattern":"^#[0-9A-Fa-f]{6}$","type":"string","description":"The hex color code for the label.","example":"#FF5733"},"sensitivity_level":{"maximum":5,"minimum":1,"type":"integer","description":"The sensitivity rank of the label.","example":5},"guideline_url":{"maxLength":512,"type":"string","description":"URL to the classification guidelines document.","format":"uri","example":"https://example.com/guidelines"},"is_default":{"type":"boolean","description":"Whether this is the default label for new whiteboards.","example":false,"default":false}}}}}},"responses":{"201":{"description":"Classification label created successfully.","content":{"application/json":{"schema":{"required":["classification_id","color","name","sensitivity_level"],"type":"object","properties":{"classification_id":{"type":"string","description":"The unique identifier of the classification label to apply.","example":"abc123xyz"},"name":{"type":"string","description":"The display name of the classification label.","example":"Confidential"},"description":{"type":"string","description":"A description of the classification label.","example":"For internal use only"},"color":{"type":"string","description":"The hex color code for the label.","example":"#FF5733"},"sensitivity_level":{"maximum":5,"minimum":1,"type":"integer","description":"The sensitivity rank of the label.","example":5},"guideline_url":{"type":"string","description":"URL to the classification guidelines document.","example":"https://example.com/guidelines"},"is_default":{"type":"boolean","description":"Whether this is the default label for new whiteboards.","example":false},"create_time":{"type":"string","description":"The timestamp when the label was created.","format":"date-time","example":"2026-01-29T10:30:00Z"},"modify_time":{"type":"string","description":"The timestamp when the label was last modified.","format":"date-time","example":"2026-01-29T10:30:00Z"}}}}}},"400":{"description":"**HTTP Status Code:** `400` <br>\n Bad Request  \n\n **Error Code:** `34002` <br>\n Invalid field {field_name}, reason: {reason}. <br>\n"},"403":{"description":"**HTTP Status Code:** `403` <br>\n Forbidden  \n\n **Error Code:** `34003` <br>\n Insufficient permissions to manage classification labels. Requires whiteboard management permissions. <br>\n**Error Code:** `34004` <br>\n Data classification feature is not enabled for this account. <br>\n"},"409":{"description":"**HTTP Status Code:** `409` <br>\n Conflict  \n\n **Error Code:** `34006` <br>\n  Maximum label limit (30) reached for this account. <br>\n"},"429":{"description":"**HTTP Status Code:** `429` <br>\n Too Many Requests. For more information, see [rate limits](https://developers.zoom.us/docs/api/rate-limits/). \n\n "}},"security":[{"openapi_oauth":["whiteboard_classification_labels:write:admin","whiteboard:write:classification_labels:admin"],"openapi_authorization":[]}],"x-extensions":{"x-permissions":["WhiteboardManagement:Edit"],"x-macro-scopes":["whiteboard_classification_labels:write:admin"],"x-granular-scopes":["whiteboard:write:classification_labels:admin"]}}},"/whiteboards/classification_labels/{classificationId}":{"get":{"tags":["Classification Labels"],"summary":"Get classification label","description":"Retrieves detailed information about a specific classification label.\n\n**[Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `whiteboard_classification_labels:read:admin`\n\n**[Granular Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `whiteboard:read:classification_labels:admin`\n\n**[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `LIGHT`","operationId":"getClassificationLabel","parameters":[{"name":"classificationId","in":"path","description":"The unique identifier of the classification label.","required":true,"schema":{"type":"string","example":"a1b2c3d4e5f6"}}],"responses":{"200":{"description":"Classification label retrieved successfully.","content":{"application/json":{"schema":{"type":"object","properties":{"classification_id":{"type":"string","description":"The unique identifier of the classification label","example":"abc123xyz"},"name":{"type":"string","description":"The display name of the classification label","example":"Confidential"},"description":{"type":"string","description":"A description of the classification label","example":"For internal use only"},"color":{"type":"string","description":"The hex color code for the label","example":"#FF5733"},"sensitivity_level":{"maximum":5,"minimum":1,"type":"integer","description":"The sensitivity rank of the label.","example":5},"guideline_url":{"type":"string","description":"URL to the classification guidelines document","example":"https://example.com/guidelines"},"is_default":{"type":"boolean","description":"Whether this is the default label for new whiteboards","example":false},"create_time":{"type":"string","description":"The timestamp when the label was created","format":"date-time","example":"2026-01-29T10:30:00Z"},"modify_time":{"type":"string","description":"The timestamp when the label was last modified","format":"date-time","example":"2026-01-29T10:30:00Z"}}}}}},"403":{"description":"**HTTP Status Code:** `403` <br>\n Forbidden  \n\n **Error Code:** `34004` <br>\n Feature not enabled. Data classification feature is not enabled for this account. <br>\n**Error Code:** `34003` <br>\n Insufficient permissions. <br>\n"},"404":{"description":"**HTTP Status Code:** `404` <br>\n Not Found  \n\n **Error Code:** `34005` <br>\n Label not found . <br>\n"},"429":{"description":"**HTTP Status Code:** `429` <br>\n Too Many Requests. For more information, see [rate limits](https://developers.zoom.us/docs/api/rate-limits/). \n\n "}},"security":[{"openapi_oauth":["whiteboard_classification_labels:read:admin","whiteboard:read:classification_labels:admin"],"openapi_authorization":[]}],"x-extensions":{"x-permissions":["WhiteboardManagement:Read"],"x-macro-scopes":["whiteboard_classification_labels:read:admin"],"x-granular-scopes":["whiteboard:read:classification_labels:admin"]}},"delete":{"tags":["Classification Labels"],"summary":"Delete classification label","description":"Deletes an existing classification label. This action cannot be undone.\n\n**[Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `whiteboard_classification_labels:write:admin`\n\n**[Granular Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `whiteboard:delete:classification_labels:admin`\n\n**[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `LIGHT`","operationId":"deleteClassificationLabel","parameters":[{"name":"classificationId","in":"path","description":"The unique identifier of the classification label to delete.","required":true,"schema":{"type":"string","example":"a1b2c3d4e5f6"}}],"responses":{"204":{"description":"Classification label deleted successfully. No content returned."},"403":{"description":"**HTTP Status Code:** `403` <br>\n Forbidden  \n\n **Error Code:** `34003` <br>\n You are no permission to delete this label. <br>\n"},"404":{"description":"**HTTP Status Code:** `404` <br>\n Not Found  \n\n **Error Code:** `34002` <br>\n Invalid field labelId, reason: Label not found. <br>\n"}},"security":[{"openapi_oauth":["whiteboard_classification_labels:write:admin","whiteboard:delete:classification_labels:admin"],"openapi_authorization":[]}],"x-extensions":{"x-permissions":["WhiteboardManagement:Edit"],"x-macro-scopes":["whiteboard_classification_labels:write:admin"],"x-granular-scopes":["whiteboard:delete:classification_labels:admin"]}},"patch":{"tags":["Classification Labels"],"summary":"Update a classification label","description":"Updates an existing classification label. Only the fields provided in the request body will be updated.\n\n**[Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `whiteboard_classification_labels:write:admin`\n\n**[Granular Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `whiteboard:update:classification_labels:admin`\n\n**[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `LIGHT`","operationId":"updateClassificationLabel","parameters":[{"name":"classificationId","in":"path","description":"The unique identifier of the classification label to update.","required":true,"schema":{"type":"string","example":"a1b2c3d4e5f6"}}],"requestBody":{"content":{"application/json":{"schema":{"type":"object","properties":{"name":{"maxLength":30,"minLength":1,"type":"string","description":"The display name of the classification label.","example":"Highly Confidential"},"description":{"maxLength":1000,"type":"string","description":"A description of what this classification label represents.","example":"Documents requiring maximum security measures"},"color":{"pattern":"^#[0-9A-Fa-f]{6}$","type":"string","description":"Hex color code for the label (e.g., #FF0000 for red).","example":"#FF0000"},"sensitivity_level":{"maximum":5,"minimum":1,"type":"integer","description":"The sensitivity rank of the label.","example":5},"guideline_url":{"maxLength":512,"type":"string","description":"HTTPS URL linking to classification guidelines or policies.","format":"uri","example":"https://company.example.com/policies/highly-confidential"},"is_default":{"type":"boolean","description":"Whether this label should be automatically applied to new whiteboards. Only one label can be the default.","example":false}}}}}},"responses":{"204":{"description":"Classification label updated successfully. Changes are saved as a draft."},"400":{"description":"**HTTP Status Code:** `400` <br>\n Bad Request  \n\n **Error Code:** `34002` <br>\n Invalid field {field_name}, reason: {reason}. <br>\n"},"403":{"description":"**HTTP Status Code:** `403` <br>\n Forbidden  \n\n **Error Code:** `34004` <br>\n Feature not enabled. Data classification feature is not enabled for this account. <br>\n"},"404":{"description":"**HTTP Status Code:** `404` <br>\n Not Found  \n\n **Error Code:** `34005` <br>\n Classification label not found. <br>\n"},"429":{"description":"**HTTP Status Code:** `429` <br>\n Too Many Requests. For more information, see [rate limits](https://developers.zoom.us/docs/api/rate-limits/). \n\n "}},"security":[{"openapi_oauth":["whiteboard_classification_labels:write:admin","whiteboard:update:classification_labels:admin"],"openapi_authorization":[]}],"x-extensions":{"x-permissions":["WhiteboardManagement:Edit"],"x-macro-scopes":["whiteboard_classification_labels:write:admin"],"x-granular-scopes":["whiteboard:update:classification_labels:admin"]}}},"/whiteboards/{whiteboardId}/classification":{"put":{"tags":["Classification Labels"],"summary":"Apply classification to whiteboard","description":"Applies or updates a classification label on a whiteboard. Each whiteboard can only have one classification label at a time. If the whiteboard already has a label, it will be replaced.\n\n**[Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `whiteboard:write:admin`,`whiteboard:write`\n\n**[Granular Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `whiteboard:update:whiteboard_classification`,`whiteboard:update:whiteboard_classification:admin`\n\n**[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `LIGHT`","operationId":"Applyclassificationtowhiteboard","parameters":[{"name":"whiteboardId","in":"path","description":"The whiteboard's ID.","required":true,"schema":{"type":"string","example":"HY8-AC_HSou4SXY1S-OmOg"}}],"requestBody":{"content":{"application/json":{"schema":{"required":["classification_id"],"type":"object","properties":{"classification_id":{"type":"string","description":"The unique identifier of the classification label to apply.","example":"abc123xyz"}}}}}},"responses":{"204":{"description":"Classification applied successfully."},"400":{"description":"**HTTP Status Code:** `400` <br>\n Bad Request  \n\n **Error Code:** `34002` <br>\n Invalid field {field_name}, reason: {reason}. <br>\n"},"403":{"description":"**HTTP Status Code:** `403` <br>\n Forbidden  \n\n **Error Code:** `34003` <br>\n Insufficient permissions to manage classification labels. Requires whiteboard management permissions. <br>\n**Error Code:** `34004` <br>\n Data classification feature is not enabled for this account.  <br>\n**Error Code:** `34008` <br>\n No permission to access this classification label . <br>\n**Error Code:** `34009` <br>\n No permission to access this whiteboard. <br>\n"},"404":{"description":"**HTTP Status Code:** `404` <br>\n Not Found  \n\n **Error Code:** `34005` <br>\n Classification label not found. <br>\n**Error Code:** `34007` <br>\n Whiteboard not found.  <br>\n"}},"security":[{"openapi_oauth":["whiteboard:write:admin","whiteboard:write","whiteboard:update:whiteboard_classification","whiteboard:update:whiteboard_classification:admin"],"openapi_authorization":[]}],"x-extensions":{"x-permissions":["WhiteboardManagement:Edit"],"x-macro-scopes":["whiteboard:write:admin","whiteboard:write"],"x-granular-scopes":["whiteboard:update:whiteboard_classification","whiteboard:update:whiteboard_classification:admin"]}},"delete":{"tags":["Classification Labels"],"summary":"Remove classification from whiteboard","description":"Removes the classification label from a whiteboard.\n\n**[Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `whiteboard:write`,`whiteboard:write:admin`\n\n**[Granular Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `whiteboard:delete:whiteboard_classification`,`whiteboard:delete:whiteboard_classification:admin`\n\n**[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `LIGHT`\n\n**Not supported in Gov cluster** ","operationId":"removeWhiteboardClassification","parameters":[{"name":"whiteboardId","in":"path","description":"abcHKs23sdffsdfsdf","required":true,"schema":{"type":"string","example":"The unique identifier of the whiteboard"}}],"responses":{"204":{"description":"Classification removed successfully."},"400":{"description":"**HTTP Status Code:** `400` <br>\n Bad Request  \n\n **Error Code:** `34002` <br>\n Invalid field {field_name}, reason: {reason}  <br>\n"},"403":{"description":"**HTTP Status Code:** `403` <br>\n Forbidden  \n\n **Error Code:** `34003` <br>\n Insufficient permissions to manage classification labels. Requires whiteboard management permissions. <br>\n**Error Code:** `34004` <br>\n Data classification feature is not enabled for this account. <br>\n**Error Code:** `34009` <br>\n No permission to access this whiteboard. <br>\n"},"404":{"description":"**HTTP Status Code:** `404` <br>\n Not Found  \n\n **Error Code:** `34007` <br>\n Whiteboard not found. <br>\n"}},"security":[{"openapi_oauth":["whiteboard:write","whiteboard:write:admin","whiteboard:delete:whiteboard_classification","whiteboard:delete:whiteboard_classification:admin"],"openapi_authorization":[]}],"x-extensions":{"x-permissions":["WhiteboardManagement:Edit"],"x-macro-scopes":["whiteboard:write","whiteboard:write:admin"],"x-granular-scopes":["whiteboard:delete:whiteboard_classification","whiteboard:delete:whiteboard_classification:admin"]}}},"/whiteboards/{whiteboardId}/collaborator":{"get":{"tags":["Collaborator"],"summary":"Get collaborators of a whiteboard","description":"Returns a list of a whiteboard collaborators. \n\n**[Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `whiteboard_collaborator:read:admin`,`whiteboard_collaborator:read`\n\n**[Granular Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `whiteboard:read:list_collaborators:admin`,`whiteboard:read:list_collaborators`\n\n**[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `MEDIUM`","operationId":"GetAWhiteboardCollaborator","parameters":[{"name":"whiteboardId","in":"path","description":"The ID of the whiteboard.","required":true,"schema":{"type":"string","example":"HY8-AC_HSou4SXY1S-OmOg"}}],"responses":{"200":{"description":"**HTTP Status Code:** `200`   \n \nWhiteboard collaborators returned.","content":{"application/json":{"schema":{"maxItems":1000,"type":"array","items":{"type":"object","properties":{"collaborator_id":{"type":"string","description":"`not nullable` The collaborator's unique ID.","example":"x4g6hy789k0o878k"},"collaborator_name":{"type":"string","description":"The collaborator's display name.","example":"Jack"},"user_id":{"type":"string","description":"`nullable` User ID. This response only returns if the `collaborator_type` is `0`. If the `collaborator_type` is **not** `0`, this returns null value.","example":"wf3h7uo1dk0v53bl"},"channel_id":{"type":"string","description":"`nullable` Team chat channel ID. This response only returns if the `collaborator_type` is `2`. If the `collaborator_type` is **not** `2`, this returns null value.","example":"cabc1234567defghijkl01234"},"avatar":{"type":"string","description":"The collaborator profile picture.","example":"https://content.zoom.us/swerwerw.jpeg"},"role":{"type":"integer","description":"The collaborator role type. \nEnum: \n* `0` - OWNER \n* `1` - CO_OWNER \n* `2` - EDITOR \n* `3` - COMMENTER \n* `4` - VIEWER \n","example":0,"enum":[0,1,2,3,4],"x-enum-descriptions":["OWNER","CO_OWNER","EDITOR","COMMENTER","VIEWER"]},"collaborator_type":{"type":"integer","description":"The collaborator type. \nEnum: \n* `0` - SAME_ACCOUNT_USER \n* `1` - EXTERNAL_USER \n* `2` - CHANNEL \n","example":0,"enum":[0,1,2],"x-enum-descriptions":["SAME_ACCOUNT_USER","EXTERNAL_USER","CHANNEL"]},"email":{"type":"string","description":"`nullable` Email. This response only returns if the `collaborator_type` is `0`. If the `collaborator_type` is **not** `0`, this returns null value.","example":"user@example.com"}},"description":"A user or a team chat channel who works jointly on a whiteboard."}}}}},"400":{"description":"**HTTP Status Code:** `400` <br>\n Bad Request  \n\n "},"403":{"description":"**HTTP Status Code:** `403` <br>\n Forbidden  \n\n **Error Code:** `111804` <br>\n Permission is needed to access this document. <br>\n"},"429":{"description":"**HTTP Status Code:** `429` <br>\n Too Many Requests. For more information, see [rate limits](https://developers.zoom.us/docs/api/rest/rate-limits/). \n\n "}},"security":[{"openapi_oauth":["whiteboard_collaborator:read:admin","whiteboard_collaborator:read","whiteboard:read:list_collaborators:admin","whiteboard:read:list_collaborators"],"openapi_authorization":[]}],"x-extensions":{"x-permissions":["WhiteboardManagement:Read"],"x-macro-scopes":["whiteboard_collaborator:read:admin","whiteboard_collaborator:read"],"x-granular-scopes":["whiteboard:read:list_collaborators:admin","whiteboard:read:list_collaborators"]}},"post":{"tags":["Collaborator"],"summary":"Share a whiteboard to new users or team chat channels.","description":"Add collaborators to a whiteboard.\n\n**[Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `whiteboard_collaborator:write:admin`,`whiteboard_collaborator:write`\n\n**[Granular Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `whiteboard:write:collaborator:admin`,`whiteboard:write:collaborator`\n\n**[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `MEDIUM`","operationId":"AddAWhiteboardCollaborator","parameters":[{"name":"whiteboardId","in":"path","description":"The ID of the whiteboard.","required":true,"schema":{"type":"string","example":"HY8-AC_HSou4SXY1S-OmOg"}}],"requestBody":{"content":{"application/json":{"schema":{"type":"object","properties":{"skip_notifications":{"type":"boolean","description":" **Default is false (notifications will be sent)**.\n If set to `true`, collaborators and owners will not receive direct messages or emails when the whiteboard is shared.","example":false},"invite_message":{"maxLength":280,"minLength":0,"type":"string","description":"The custom message to include with the whiteboard invitation.","example":"I'm glad to invite you to join this whiteboard."},"collaborators":{"maxItems":100,"minItems":1,"type":"array","description":"Array of collaborator objects to be added to the whiteboard.","items":{"type":"object","properties":{"email":{"type":"string","description":"**User Email Address**\nThe email address of the user you want to share the whiteboard with.\nThis field is **required** when sharing a whiteboard with an individual user.\nIt **must be left empty** when sharing via a channel.\n**Note**: email and channel_id cannot be set at the same time.","example":"user@example.com."},"channel_id":{"type":"string","description":"**Channel ID**\nThe unique identifier of the channel you want to share the whiteboard with.\nThis field is **required** when sharing a whiteboard via a channel.\nIt **must be left empty** when sharing with an individual user by email.\n**Note**: channel_id and email cannot be set at the same time.","example":"cabc1234567defghijkl01234"},"role":{"type":"integer","description":"Collaborator role type. \nWhen assigning a new `OWNER` or `CO_OWNER`, the specified user must belong to the same account as the original `OWNER`. If a new owner is designated for a whiteboard, the original owner will automatically be demoted to `CO_OWNER`.\n\nRole Enum Values: \n* `0` - OWNER \n* `1` - CO_OWNER \n* `2` - EDITOR \n* `3` - COMMENTER \n* `4` - VIEWER ","example":1,"enum":[0,1,2,3,4],"x-enum-descriptions":["OWNER","CO_OWNER","EDITOR","COMMENTER","VIEWER"]}},"description":"A user or a team chat channel who works jointly on a whiteboard. \n* `Email` or `ChannelId` is required according to the audience `type`."}}},"description":"Users or team chat channels to be added as collaborators to the whiteboard."}}}},"responses":{"201":{"description":"**HTTP Status Code:** `201`   \n\n Whiteboard added collaborators returned.","content":{"application/json":{"schema":{"maxItems":100,"type":"array","items":{"type":"object","properties":{"collaborator_id":{"type":"string","description":"The collaborator's unique identifier. This field is not nullable.","example":"x4g6hy789k0o878k"},"collaborator_name":{"type":"string","description":"The collaborator's display name.","example":"Jack"},"user_id":{"type":"string","description":"`nullable` User ID. This response only returns if the `collaborator_type` is `0`. If the `collaborator_type` is **not** `0`, this returns null value.","example":"wf3h7uo1dk0v53bl"},"channel_id":{"type":"string","description":"`nullable` Team chat channel ID. This response only returns if the `collaborator_type` is `2`. If the `collaborator_type` is **not** `2`, this returns null value.","example":"cabc1234567defghijkl01234"},"avatar":{"type":"string","description":"Collaborator profile picture.","example":"https://content.zoom.us/swerwerw.jpeg"},"role":{"type":"integer","description":"Collaborator role type. \nEnum: \n* `0` - OWNER \n* `1` - CO_OWNER \n* `2` - EDITOR \n* `3` - COMMENTER \n* `4` - VIEWER \n","example":0,"enum":[0,1,2,3,4],"x-enum-descriptions":["OWNER","CO_OWNER","EDITOR","COMMENTER","VIEWER"]},"collaborator_type":{"type":"integer","description":"Collaborator type. \nEnum: \n* `0` - SAME_ACCOUNT_USER \n* `1` - EXTERNAL_USER \n* `2` - CHANNEL \n","example":0,"enum":[0,1,2],"x-enum-descriptions":["SAME_ACCOUNT_USER","EXTERNAL_USER","CHANNEL"]}},"description":"A user or team chat channel who works jointly on a whiteboard."}}}}},"400":{"description":"**HTTP Status Code:** `400` <br>\n Bad Request  \n\n "},"403":{"description":"**HTTP Status Code:** `403` <br>\n Forbidden  \n\n "},"404":{"description":"**HTTP Status Code:** `404` <br>\n Not Found  \n\n "},"429":{"description":"**HTTP Status Code:** `429` <br>\n Too Many Requests. For more information, see [rate limits](https://developers.zoom.us/docs/api/rate-limits/). \n\n "}},"security":[{"openapi_oauth":["whiteboard_collaborator:write:admin","whiteboard_collaborator:write","whiteboard:write:collaborator:admin","whiteboard:write:collaborator"],"openapi_authorization":[]}],"x-extensions":{"x-permissions":["WhiteboardManagement:Edit"],"x-macro-scopes":["whiteboard_collaborator:write:admin","whiteboard_collaborator:write"],"x-granular-scopes":["whiteboard:write:collaborator:admin","whiteboard:write:collaborator"]}},"patch":{"tags":["Collaborator"],"summary":"Update whiteboard collaborators","description":"Use this API to update whiteboard collaborators. \n\n\n\n**[Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `whiteboard_collaborator:write:admin`,`whiteboard_collaborator:write`\n\n**[Granular Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `whiteboard:update:collaborator:admin`,`whiteboard:update:collaborator`\n\n**[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `MEDIUM`","operationId":"UpdateAWhiteboardCollaborator","parameters":[{"name":"whiteboardId","in":"path","description":"The ID of the whiteboard.","required":true,"schema":{"type":"string","example":"HY8-AC_HSou4SXY1S-OmOg"}}],"requestBody":{"content":{"application/json":{"schema":{"type":"object","properties":{"collaborators":{"maxItems":100,"minItems":1,"type":"array","description":"An array of collaborator objects.","items":{"type":"object","properties":{"collaborator_id":{"type":"string","description":"The collaborator's unique ID `not nullable` .","example":"x4g6hy789k0o878k"},"role":{"type":"integer","description":"Collaborator role type. \nWhen assigning a new `OWNER` or `CO_OWNER`, the specified user must belong to the same account as the original `OWNER`. If a new owner is designated for a whiteboard, the original owner will automatically be demoted to `CO_OWNER`.\n\nRole Enum Values: \n* `0` - OWNER \n* `1` - CO_OWNER \n* `2` - EDITOR \n* `3` - COMMENTER \n* `4` - VIEWER ","example":0,"enum":[0,1,2,3,4],"x-enum-descriptions":["OWNER","CO_OWNER","EDITOR","COMMENTER","VIEWER"]}}}}},"description":"Update collaborators permission of a whiteboard."}}}},"responses":{"204":{"description":"**HTTP Status Code**: `204`   \n \nWhiteboard collaborators updated successfully."},"400":{"description":"**HTTP Status Code:** `400` <br>\n Bad Request  \n\n **Error Code:** `34002` <br>\n Invalid collaboratorId {collaboratorId}. <br>\n"},"403":{"description":"**HTTP Status Code:** `403` <br>\n Forbidden  \n\n **Error Code:** `111804` <br>\n Permission is needed to access this document. <br>\n"},"404":{"description":"**HTTP Status Code:** `404` <br>\n Not Found  \n\n **Error Code:** `34000` <br>\n The resource {whiteboardId} not exist. <br>\n"},"429":{"description":"**HTTP Status Code:** `429` <br>\n Too Many Requests. For more information, see [rate limits](https://developers.zoom.us/docs/api/rest/rate-limits/). \n\n "}},"security":[{"openapi_oauth":["whiteboard_collaborator:write:admin","whiteboard_collaborator:write","whiteboard:update:collaborator:admin","whiteboard:update:collaborator"],"openapi_authorization":[]}],"x-extensions":{"x-permissions":["WhiteboardManagement:Edit"],"x-macro-scopes":["whiteboard_collaborator:write:admin","whiteboard_collaborator:write"],"x-granular-scopes":["whiteboard:update:collaborator:admin","whiteboard:update:collaborator"]}}},"/whiteboards/{whiteboardId}/collaborator/{collaboratorId}":{"delete":{"tags":["Collaborator"],"summary":"Remove the collaborator from a whiteboard","description":"Removes a collaborator from a whiteboard. \n\n\n\n**[Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `whiteboard_collaborator:write:admin`,`whiteboard_collaborator:write`\n\n**[Granular Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `whiteboard:delete:collaborator:admin`,`whiteboard:delete:collaborator`\n\n**[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `MEDIUM`","operationId":"DeleteAWhiteboardCollaborator","parameters":[{"name":"whiteboardId","in":"path","description":"The ID of the whiteboard.","required":true,"schema":{"type":"string","example":"HY8-AC_HSou4SXY1S-OmOg"}},{"name":"collaboratorId","in":"path","description":"The ID of the whiteboard collaborator.","required":true,"schema":{"type":"string","example":"sWvlvz-G5XFQxpfxEBB0PfVALRdcpHdTAqwqigrOPb1TgkxtFJI.3Z6nozeexgNAEecI"}}],"responses":{"204":{"description":"**HTTP Status Code**: `204`   \n \nWhiteboard collaborators deleted successfully."},"403":{"description":"**HTTP Status Code:** `403` <br>\n Forbidden  \n\n **Error Code:** `111804` <br>\n Permission is needed to access this document. <br>\n"},"404":{"description":"**HTTP Status Code:** `404` <br>\n Not Found  \n\n **Error Code:** `34002` <br>\n Resource not found.  <br>\n"},"429":{"description":"**HTTP Status Code:** `429` <br>\n Too Many Requests. For more information, see [rate limits](https://developers.zoom.us/docs/api/rest/rate-limits/). \n\n "}},"security":[{"openapi_oauth":["whiteboard_collaborator:write:admin","whiteboard_collaborator:write","whiteboard:delete:collaborator:admin","whiteboard:delete:collaborator"],"openapi_authorization":[]}],"x-extensions":{"x-permissions":["WhiteboardManagement:Edit"],"x-macro-scopes":["whiteboard_collaborator:write:admin","whiteboard_collaborator:write"],"x-granular-scopes":["whiteboard:delete:collaborator:admin","whiteboard:delete:collaborator"]}}},"/whiteboards/{whiteboardId}/content":{"get":{"tags":["Content"],"summary":"Get Whiteboard Content","description":"Get whiteboard content.\n\n**[Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `whiteboard_content:read`\n\n**[Granular Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `whiteboard:read:content`\n\n**[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `LIGHT`\n\n**Not supported in Gov cluster** ","operationId":"GetWhiteboardContent","parameters":[{"name":"whiteboardId","in":"path","description":"The whiteboard ID.","required":true,"schema":{"type":"string","example":"HY8-AC_HSou4SXY1S-OmOg"}}],"responses":{"200":{"description":"Whiteboard content returned successfully.","content":{"application/json":{"schema":{"type":"object","properties":{"whiteboard_id":{"type":"string","description":"The whiteboard ID.","example":"idPIpcmxS1mDgW2uwir29A"},"page_id":{"type":"string","description":"The ID of the first page in the whiteboard. Content access is scoped to the first page only.","example":"24844607488000"},"content_objects":{"type":"array","description":"List of whiteboard objects (shapes, text, images, connectors, etc.). Each object is a free-form JSON map whose schema is determined by the whiteboard renderer. Maximum 10,000 items.","example":[{"type":"rect","x":100,"y":200}],"items":{"type":"object","additionalProperties":true}}}}}}},"403":{"description":"**HTTP Status Code:** `403` <br>\n Forbidden  \n\n **Error Code:** `111804` <br>\n Permission is needed to access this whiteboard. <br>\n"},"429":{"description":"**HTTP Status Code:** `429` <br>\n Too Many Requests. For more information, see [rate limits](https://developers.zoom.us/docs/api/rate-limits/). \n\n "},"500":{"description":"**HTTP Status Code:** `500` <br>\n Internal Server Error  \n\n "}},"security":[{"openapi_oauth":["whiteboard_content:read","whiteboard:read:content"],"openapi_authorization":[]}],"x-extensions":{"x-permissions":[],"x-macro-scopes":["whiteboard_content:read"],"x-granular-scopes":["whiteboard:read:content"]}},"post":{"tags":["Content"],"summary":"Save Whiteboard Content","description":"Save whiteboard content.\n\n**[Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `whiteboard_content:write`\n\n**[Granular Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `whiteboard:write:content`\n\n**[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `LIGHT`\n\n**Not supported in Gov cluster** ","operationId":"SaveWhiteboardContent","parameters":[{"name":"whiteboardId","in":"path","description":"The ID of the whiteboard.","required":true,"schema":{"type":"string","example":"HY8-AC_HSou4SXY1S-OmOg"}}],"requestBody":{"content":{"application/json":{"schema":{"required":["content_objects"],"type":"object","properties":{"content_objects":{"type":"array","description":"List of whiteboard objects (shapes, text, images, connectors, etc.). Each object is a free-form JSON map whose schema is determined by the whiteboard renderer. Maximum 10,000 items.","example":[{"type":"rect","x":100,"y":200}],"items":{"type":"object","additionalProperties":true}}}}}}},"responses":{"201":{"description":"Whiteboard content saved successfully.","content":{"application/json":{"schema":{"type":"object","properties":{"page_id":{"type":"string","description":"The ID of the page where the whiteboard content was saved.","example":"24844607488000"},"added":{"type":"number","description":"The number of added objects.","example":1},"updated":{"type":"number","description":"The number of updated objects.","example":1}}}}}},"400":{"description":"**HTTP Status Code:** `400` <br>\n Bad Request  \n\n "},"403":{"description":"**HTTP Status Code:** `403` <br>\n Forbidden  \n\n **Error Code:** `111804` <br>\n Permission is needed to access this whiteboard. <br>\n"},"429":{"description":"**HTTP Status Code:** `429` <br>\n Too Many Requests. For more information, see [rate limits](https://developers.zoom.us/docs/api/rate-limits/). \n\n "},"500":{"description":"**HTTP Status Code:** `500` <br>\n Internal Server Error  \n\n "}},"security":[{"openapi_oauth":["whiteboard_content:write","whiteboard:write:content"],"openapi_authorization":[]}],"x-extensions":{"x-permissions":[],"x-macro-scopes":["whiteboard_content:write"],"x-granular-scopes":["whiteboard:write:content"]}},"delete":{"tags":["Content"],"summary":"Delete Whiteboard Content","description":"Delete whiteboard content.\n\n**[Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `whiteboard:write`\n\n**[Granular Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `whiteboard:delete:content`\n\n**[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `LIGHT`\n\n**Not supported in Gov cluster** ","operationId":"DeleteWhiteboardContent","parameters":[{"name":"whiteboardId","in":"path","description":"The whiteboard ID.","required":true,"schema":{"type":"string","example":"HY8-AC_HSou4SXY1S-OmOg"}}],"requestBody":{"description":"Delete whiteboard content.","content":{"application/json":{"schema":{"required":["object_ids"],"type":"object","properties":{"object_ids":{"minItems":1,"type":"array","description":"A list of whiteboard content object IDs.","items":{"type":"string","description":"The object ID.","example":"21291718632140"}}}}}}},"responses":{"204":{"description":"Whiteboard content deleted successfully."},"400":{"description":"**HTTP Status Code:** `400` <br>\n Bad Request \n\n "},"403":{"description":"**HTTP Status Code:** `403` <br>\n Forbidden \n\n **Error Code:** `111804` <br>\n Permission is needed to access this whiteboard. <br>\n"},"429":{"description":"**HTTP Status Code:** `429` <br>\n Too Many Requests. For more information, see [rate limits](https://developers.zoom.us/docs/api/rate-limits/). \n\n "},"500":{"description":"**HTTP Status Code:** `500` <br>\n Internal Server Error \n\n "}},"security":[{"openapi_oauth":["whiteboard:write","whiteboard:delete:content"],"openapi_authorization":[]}],"x-extensions":{"x-permissions":[],"x-macro-scopes":["whiteboard:write"],"x-granular-scopes":["whiteboard:delete:content"]}}},"/whiteboards":{"get":{"tags":["Document"],"summary":"List all whiteboards","description":"Use this API to list whiteboards of current user (**Required Scopes**: `whiteboard:read`) or list all whiteboards under the account (**Required Scopes**: `whiteboard:read:admin`).\n\n**Note:** `user_id` can intake `Zoom user ID` or `email` which only applies when scope = `whiteboard:read:admin`. Otherwise, the `user_id` can only intake `me`.\n\n**[Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `whiteboard:read:admin`,`whiteboard:read`\n\n**[Granular Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `whiteboard:read:list_whiteboards:admin`,`whiteboard:read:list_whiteboards`\n\n**[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `MEDIUM`","operationId":"ListWhiteboards","parameters":[{"name":"search_key","in":"query","description":"The name of a whiteboard. If this parameter is provided, only the matched whiteboard will be returned. Otherwise, all whiteboards will be returned.","required":false,"schema":{"type":"string","example":"PGsQ3nwITmyTG4JkFNWJcg"}},{"name":"user_id","in":"query","description":"The email address or user ID of the whiteboard owner. If this parameter is provided, only the whiteboard owned by the provided user will be returned. \nIf set to `me`, will return the matched whiteboards of current user.","required":false,"schema":{"type":"string","example":"me"}},{"name":"date_filter_type","in":"query","description":"The whiteboard date filter type. \nEnum:\n* `created_date` - Whiteboard create date. \n* `modified_date` - Whiteboard modify date.\n","required":false,"schema":{"type":"string","example":"modified_date","default":"modified_date","enum":["created_date","modified_date"]}},{"name":"from","in":"query","description":"The queried start date and time in `yyyy-MM-dd'T'HH:mm:ss'Z'` UTC format for the created date range for which you would like to retrieve whiteboards. The maximum range can be a month. If no value is provided for this field, the default will be current date. For example, if you make the API request on June 30, 2020, without providing the &ldquo;from&rdquo; and &ldquo;to&rdquo; parameters, by default the value of 'from' field will be &ldquo;2020-06-30&rdquo; and the value of the 'to' field will be &ldquo;2020-07-01&rdquo;.","required":false,"schema":{"type":"string","format":"date-time","example":"2022-03-08T16:00:00Z"}},{"name":"to","in":"query","description":"The queried end date and time in `yyyy-MM-dd'T'HH:mm:ss'Z'` UTC format. ","required":false,"schema":{"type":"string","format":"date-time","example":"2022-03-08T16:00:00Z"}},{"name":"page_size","in":"query","description":"The number of records returned from a single API call.","required":false,"schema":{"maximum":50,"type":"integer","example":10,"default":10}},{"name":"next_page_token","in":"query","description":"The next page token is used to paginate through large result sets. A next page token will be returned whenever the set of available results exceeds the current page size. The expiration period for this token is 15 minutes.","required":false,"schema":{"type":"string","example":"R4aF9Oj0fVM2hhezJTEmSKaBSkfesDwGy42"}},{"name":"project_id","in":"query","description":"Project ID to search for.","required":false,"schema":{"type":"string","example":"N6XZFDEQTkWSsMsmO_M1XQ"}}],"responses":{"200":{"description":"**HTTP Status Code:** `200`   \n \nWhiteboard list returned.","content":{"application/json":{"schema":{"title":"Whiteboard List","description":"The whiteboard list.","allOf":[{"type":"object","properties":{"whiteboards":{"maxItems":50,"type":"array","description":"The information about the whiteboard list.","items":{"allOf":[{"type":"object","properties":{"whiteboard_id":{"type":"string","description":"Whiteboard ID","example":"48Z4ppMfQJWONeVWFCcVzA"},"whiteboard_name":{"type":"string","description":"Whiteboard name","example":"Q3 Plan","default":"Untitled"},"locked":{"type":"boolean","description":"Indicates whether the whiteboard is locked or not.\n\n`true`: The whiteboard is locked.   \n \n\n`false`: The whiteboard is unlocked","example":false,"default":false},"trashed":{"type":"boolean","description":"Indicates whether the whiteboard is moved to trash or not.\n\n`true`: The whiteboard is moved to trash.   \n \n\n`false`: The whiteboard isn't moved to trash","example":false,"default":false},"readonly":{"type":"boolean","description":"Indicates whether the whiteboard is editable or not. If a whiteboard is locked, this field will set `true`. \n\n`true`: The whiteboard is editable.   \n \n\n`false`: The whiteboard is readonly","example":false,"default":false},"non_cloud":{"type":"boolean","description":"Indicates whether the whiteboard is allowed to be saved to cloud or not.\n\n`true`: The whiteboard is a saved to cloud.   \n \n\n`false`: The whiteboard isn't saved to cloud","example":false,"default":false},"created_date":{"type":"string","description":"Whiteboard create date-time in UTC/GMT. Example: &quot;2020-03-31T12:02:00Z&quot;","format":"date-time","example":"2022-03-25T07:29:29Z"},"modified_date":{"type":"string","description":"Whiteboard update date-time in UTC/GMT. Example: &quot;2020-03-31T12:02:00Z&quot;","format":"date-time","example":"2022-03-25T07:29:29Z"},"share_link_setting":{"type":"object","properties":{"share_scope":{"type":"integer","description":"The access type of whiteboard share link. \n* Enum: \n* `0` - `Restricted`, Only people added can open with this link \n* `1` - `Same account` \n* `2` - Anyone \n* `3` - SAME_ACCOUNT_EXTERNAL_AUTH \n","example":0,"default":0,"enum":[0,1,2,3],"x-enum-descriptions":["Restricted. Only people added can open with this link","Same account","Anyone","Same account external auth"]},"share_role":{"type":"integer","description":"The access level of whiteboard share link. This field need to used with `share_scope`. If `share_scope` set `0` - `Restricted`, this field is null. If `share_scope` set `1` - `Same account` or `2` - `Anyone`, this filed can be `2` - `Editor`, `3` - `Commenter` or `4` - `Viewer`. \n* Enum: \n* `2` - `Editor`\n* `3` - `Commenter` \n* `4` - Viewer \n","example":2,"enum":[2,3,4],"x-enum-descriptions":["Editor","Commenter","Viewer"]}},"description":"The access level, access type of current whiteboard share link."},"advanced_share_setting":{"type":"object","properties":{"can_share":{"type":"boolean","description":"Indicate whether users can share at or below their permission level or not. \n\n`true`: Users can share at or below their permission level.   \n \n\n`false`: Users cannot share at or below their permission level.","example":true},"share_to_external":{"type":"boolean","description":"Indicate whether internal users can share with external users or not. \n\n`true`: Internal users can share with external users.   \n \n\n`false`: Internal users cannot share with external users.","example":true},"external_can_share":{"type":"boolean","description":"Indicate whether external user can share the whiteboard to others or not. \n\n`true`: External user can share the whiteboard to others.   \n \n\n`false`:External user cannot share the whiteboard to others.","example":true}},"description":"Whiteboard advanced share setting."},"project_id":{"type":"string","description":"qiMWddmtRxqwSFrK22lJPg","example":"The Project ID"},"created_by_display_name":{"type":"string","description":"The creator display name of the whiteboard.","example":"Jack"}},"description":"Whiteboard object"}]}},"next_page_token":{"type":"string","description":"The next page token paginates through a large set of results. A next page token is returned when the available results exceed the current page size. The expiration period for this token is 15 minutes.","example":"qUEQqB1V0HVhJmwKFQrGOD"},"page_size":{"type":"integer","description":"The number of records returned per page in a single API call.","example":10},"total_records":{"type":"integer","description":"The total number of records found.","example":2}}}]}}}},"400":{"description":"**HTTP Status Code:** `400` <br>\n Bad Request  \n\n "},"429":{"description":"**HTTP Status Code:** `429` <br>\n Too Many Requests. For more information, see [rate limits](https://developers.zoom.us/docs/api/rest/rate-limits/). \n\n "}},"security":[{"openapi_oauth":["whiteboard:read:admin","whiteboard:read","whiteboard:read:list_whiteboards:admin","whiteboard:read:list_whiteboards"],"openapi_authorization":[]}],"x-extensions":{"x-permissions":["WhiteboardManagement:Read"],"x-macro-scopes":["whiteboard:read:admin","whiteboard:read"],"x-granular-scopes":["whiteboard:read:list_whiteboards:admin","whiteboard:read:list_whiteboards"]}},"post":{"tags":["Document"],"summary":"Create a new whiteboard","description":"Creates a new whiteboard for a user.\n\n**[Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `whiteboard:write`\n\n**[Granular Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `whiteboard:write:whiteboard`\n\n**[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `LIGHT`","operationId":"newWhiteboardCreate","requestBody":{"content":{"application/json":{"schema":{"type":"object","properties":{"name":{"type":"string","description":"The whiteboard name.","example":"Q3 Plan","default":"Untitled"}},"description":"Create a new whiteboard request body."}}}},"responses":{"201":{"description":"**HTTP Status Code:** `201`   \n \nWhiteboard created successfully.","content":{"application/json":{"schema":{"type":"object","properties":{"whiteboard_id":{"type":"string","description":"The whiteboard ID.","example":"48Z4ppMfQJWONeVWFCcVzA"},"whiteboard_name":{"type":"string","description":"The whiteboard name.","example":"Q3 Plan","default":"Untitled"},"locked":{"type":"boolean","description":"Indicates whether the whiteboard is locked or not.\n\n`true`: The whiteboard is locked.   \n \n\n`false`: The whiteboard is unlocked.","example":false,"default":false},"trashed":{"type":"boolean","description":"Indicates whether the whiteboard is moved to trash or not.\n\n`true`: The whiteboard is moved to trash.   \n \n\n`false`: The whiteboard was not moved to trash.","example":false,"default":false},"readonly":{"type":"boolean","description":"Indicates whether the whiteboard is editable or not. If a whiteboard is locked, this field will set `true`. \n\n`true`: The whiteboard is editable.   \n \n\n`false`: The whiteboard is read only.","example":false,"default":false},"non_cloud":{"type":"boolean","description":"Indicates whether the whiteboard is allowed to be saved to cloud or not.\n\n`true`: The whiteboard is a saved to cloud.   \n \n\n`false`: The whiteboard was not saved to cloud.","example":false,"default":false},"created_date":{"type":"string","description":"The whiteboard create date-time in UTC/GMT. Example: &quot;`2020-03-31T12:02:00Z`&quot;","format":"date-time","example":"2022-03-25T07:29:29Z"},"modified_date":{"type":"string","description":"The whiteboard update date-time in UTC/GMT. Example: &quot;2020-03-31T12:02:00Z&quot;","format":"date-time","example":"2022-03-25T07:29:29Z"},"share_link_setting":{"type":"object","properties":{"share_scope":{"type":"integer","description":"The access type of whiteboard share link. \n* Enum: \n* `0` - `Restricted`, Only people added can open with this link \n* `1` - `Same account` \n* `2` - Anyone \n* `3` - SAME_ACCOUNT_EXTERNAL_AUTH \n","example":0,"default":0,"enum":[0,1,2,3],"x-enum-descriptions":["Restricted. Only people added can open with this link","Same account","Anyone","Same account external auth"]},"share_role":{"type":"integer","description":"The access level of whiteboard share link. This field need to used with `share_scope`. If `share_scope` set `0` - `Restricted`, this field is null. If `share_scope` set `1` - `Same account` or `2` - `Anyone`, this filed can be `2` - `Editor`, `3` - `Commenter` or `4` - `Viewer`. \n* Enum: \n* `2` - `Editor`\n* `3` - `Commenter` \n* `4` - Viewer \n","example":2,"enum":[2,3,4],"x-enum-descriptions":["Editor","Commenter","Viewer"]}},"description":"The access level, access type of current whiteboard share link."},"advanced_share_setting":{"type":"object","properties":{"can_share":{"type":"boolean","description":"Indicate whether users can share at or below their permission level or not. \n\n`true`: Users can share at or below their permission level.   \n \n\n`false`: Users cannot share at or below their permission level.","example":true},"share_to_external":{"type":"boolean","description":"Indicate whether internal users can share with external users or not. \n\n`true`: Internal users can share with external users.   \n \n\n`false`: Internal users cannot share with external users.","example":true},"external_can_share":{"type":"boolean","description":"Indicate whether external user can share the whiteboard to others or not. \n\n`true`: External user can share the whiteboard to others.   \n \n\n`false`:External user cannot share the whiteboard to others.","example":true}},"description":"Whiteboard advanced share setting."}},"description":"The whiteboard object."}}}},"400":{"description":"**HTTP Status Code:** `400` <br>\n Bad Request  \n\n "},"429":{"description":"**HTTP Status Code:** `429` <br>\n Too Many Requests. For more information, see [rate limits](https://developers.zoom.us/docs/api/rest/rate-limits/). \n\n "}},"security":[{"openapi_oauth":["whiteboard:write","whiteboard:write:whiteboard"],"openapi_authorization":[]}],"x-extensions":{"x-permissions":[],"x-macro-scopes":["whiteboard:write"],"x-granular-scopes":["whiteboard:write:whiteboard"]}}},"/whiteboards/{whiteboardId}":{"get":{"tags":["Document"],"summary":"Get a whiteboard","description":"Returns a whiteboard's information.\n\n**[Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `whiteboard:read:admin`,`whiteboard:read`\n\n**[Granular Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `whiteboard:read:whiteboard:admin`,`whiteboard:read:whiteboard`\n\n**[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `MEDIUM`","operationId":"GetAWhiteboard","parameters":[{"name":"whiteboardId","in":"path","description":"The whiteboard's ID.","required":true,"schema":{"type":"string","example":"HY8-AC_HSou4SXY1S-OmOg"}}],"responses":{"200":{"description":"**HTTP Status Code:** `200`   \n \nWhiteboard object returned.","content":{"application/json":{"schema":{"type":"object","properties":{"whiteboard_id":{"type":"string","description":"The whiteboard ID.","example":"48Z4ppMfQJWONeVWFCcVzA"},"whiteboard_name":{"type":"string","description":"The whiteboard name.","example":"Q3 Plan","default":"Untitled"},"locked":{"type":"boolean","description":"Indicates whether the whiteboard is locked or not.\n\n`true`-  The whiteboard is locked.   \n \n\n`false` - The whiteboard is unlocked.","example":false,"default":false},"trashed":{"type":"boolean","description":"Indicates whether the whiteboard is moved to trash or not.\n\n`true` - The whiteboard is moved to trash.   \n \n\n`false` - The whiteboard isn't moved to trash.","example":false,"default":false},"readonly":{"type":"boolean","description":"Indicates whether the whiteboard is editable or not. If a whiteboard is locked, this field will be set to `true`. \n\n`true` - The whiteboard is editable.   \n \n\n`false` - The whiteboard is read only.","example":false,"default":false},"non_cloud":{"type":"boolean","description":"Indicates whether the whiteboard is allowed to be saved to cloud or not.\n\n`true` - The whiteboard is a saved to cloud.   \n \n\n`false` - The whiteboard isn't saved to cloud.","example":false,"default":false},"created_date":{"type":"string","description":"The whiteboard creation date and time in UTC/GMT. Example: `2020-03-31T12:02:00Z`","format":"date-time","example":"2022-03-25T07:29:29Z"},"modified_date":{"type":"string","description":"The whiteboard update date and time in UTC/GMT. Example: `2020-03-31T12:02:00Z`","format":"date-time","example":"2022-03-25T07:29:29Z"},"share_link_setting":{"type":"object","properties":{"share_scope":{"type":"integer","description":"The access type of whiteboard sharing link. \n* Enum: \n* `0` - `Restricted`. Only people added can open with this link. \n* `1` - `Same account` \n* `2` - Anyone \n* `3` - `SAME_ACCOUNT_EXTERNAL_AUTH` \n","example":0,"default":0,"enum":[0,1,2,3],"x-enum-descriptions":["Restricted. Only people added can open with this link","Same account","Anyone","Same account external auth"]},"share_role":{"type":"integer","description":"The access level of whiteboard share link. This field need to used with `share_scope`. If `share_scope` set `0` - `Restricted`. This field is null. If `share_scope` set `1` - `Same account` or `2` - `Anyone`, this field can be `2` - `Editor`, `3` - `Commenter` or `4` - `Viewer`. \n* Enum: \n* `2` - `Editor`\n* `3` - `Commenter` \n* `4` - Viewer \n","example":2,"enum":[2,3,4],"x-enum-descriptions":["Editor","Commenter","Viewer"]}},"description":"The access level, access type of current whiteboard share link."},"advanced_share_setting":{"type":"object","properties":{"can_share":{"type":"boolean","description":"Indicate whether users can share at or below their permission level or not. \n\n`true`: Users can share at or below their permission level.   \n \n\n`false`: Users cannot share at or below their permission level.","example":true},"share_to_external":{"type":"boolean","description":"Indicate whether internal users can share with external users or not. \n\n`true`: Internal users can share with external users.   \n \n\n`false`: Internal users cannot share with external users.","example":true},"external_can_share":{"type":"boolean","description":"Indicate whether external user can share the whiteboard to others or not. \n\n`true`: External user can share the whiteboard to others.   \n \n\n`false`:External user cannot share the whiteboard to others.","example":true}},"description":"The whiteboard advanced share setting."},"share_link":{"type":"string","description":"The whiteboard share link.","example":"https://zoom.us/wb/doc/T-E0zR9NQWSDuvXd-Crt9A"},"preview_link":{"type":"string","description":"The whiteboard preview link. This link's validity period is `2 hours`, and the maximum number of downloads is `99 times`. Only those who have the `whiteboard:read:whiteboard` scope or are collaborators of the whiteboard will see this field returned.","example":"https://a01file.zoom.us/file/xxxxx/attach/preview/192x108?jwt=xxx"},"created_by_display_name":{"type":"string","description":"The creator display name of the whiteboard.","example":"Tom"},"modified_by_display_name":{"type":"string","description":"The latest modify user display name of the whiteboard.","example":"Jack"},"embedded_content_types":{"type":"array","description":"The embedded content type list.","items":{"maximum":2,"minimum":0,"type":"integer","description":"The type of embeded content in whiteboard. it's an enum contains `0`, `1`, `2`.\nThe description of the enums:\n- **0** - **IMAGE**.\n- **1** - **DOCUMENT**, this would include PDFs, PPTX, DOCX, GOOGLE DOCS, SHEETS and SLIDES.\n- **2** - **CARD**, this would include Jira, Asana and Azure DevOps.","format":"int32","example":0,"default":0,"enum":[0,1,2],"x-enum-descriptions":["IMAGE","DOCUMENT","CARD"]}},"project_id":{"type":"string","description":"The Project ID","example":"qiMWddmtRxqwSFrK22lJPg"},"classification_label":{"type":"object","properties":{"id":{"type":"string","description":"The unique identifier of the classification label.","example":"abc123xyz"},"name":{"type":"string","description":"The display name of the classification label.","example":"Confidential"},"description":{"type":"string","description":"A description of the classification label.","example":"For internal use only"},"color":{"type":"string","description":"The hex color code for the label.","example":"#FF5733"},"sensitivity_level":{"maximum":5,"minimum":1,"type":"integer","description":"The sensitivity rank of the label.","example":5},"guideline_url":{"type":"string","description":"URL to the classification guidelines document.","example":"https://example.com/guidelines"}},"description":"The classification label applied to this whiteboard. Null if no classification is applied.","nullable":true}},"description":"Whiteboard object"}}}},"400":{"description":"**HTTP Status Code:** `400` <br>\n Bad Request  \n\n "},"403":{"description":"**HTTP Status Code:** `403` <br>\n Forbidden  \n\n **Error Code:** `111800` <br>\n Permission is needed to access this document. <br>\n"},"429":{"description":"**HTTP Status Code:** `429` <br>\n Too Many Requests. For more information, see [rate limits](https://developers.zoom.us/docs/api/rest/rate-limits/). \n\n "}},"security":[{"openapi_oauth":["whiteboard:read:admin","whiteboard:read","whiteboard:read:whiteboard:admin","whiteboard:read:whiteboard"],"openapi_authorization":[]}],"x-extensions":{"x-permissions":["WhiteboardManagement:Read"],"x-macro-scopes":["whiteboard:read:admin","whiteboard:read"],"x-granular-scopes":["whiteboard:read:whiteboard:admin","whiteboard:read:whiteboard"]}},"put":{"tags":["Document"],"summary":"Update whiteboard basic information","description":"Use this API to rename a whiteboard, update whiteboard status (locked or unlocked). \n\n**[Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `whiteboard:write:admin`\n\n**[Granular Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `whiteboard:update:whiteboard:admin`\n\n**[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `MEDIUM`","operationId":"UpdateAWhiteboardMetadata","parameters":[{"name":"whiteboardId","in":"path","description":"The ID of the whiteboard.","required":true,"schema":{"type":"string","example":"HY8-AC_HSou4SXY1S-OmOg"}}],"requestBody":{"content":{"application/json":{"schema":{"type":"object","properties":{"name":{"type":"string","description":"The whiteboard name.","example":"Q3 Plan","default":"Untitled"},"locked":{"type":"boolean","description":"Indicates whether the whiteboard is locked or not.\n\n`true`: The whiteboard is locked.   \n \n\n`false`: The whiteboard is unlocked.","example":false,"default":false}},"description":"Update a whiteboard request body"}}}},"responses":{"204":{"description":"**HTTP Status Code**: `204`   \n \nWhiteboard updated successfully."},"400":{"description":"**HTTP Status Code:** `400` <br>\n Bad Request  \n\n "},"403":{"description":"**HTTP Status Code:** `403` <br>\n Forbidden  \n\n **Error Code:** `111800` <br>\n Permission is needed to access this document. <br>\n"},"429":{"description":"**HTTP Status Code:** `429` <br>\n Too Many Requests. For more information, see [rate limits](https://developers.zoom.us/docs/api/rest/rate-limits/). \n\n "}},"security":[{"openapi_oauth":["whiteboard:write:admin","whiteboard:update:whiteboard:admin"],"openapi_authorization":[]}],"x-extensions":{"x-permissions":["WhiteboardManagement:Edit"],"x-macro-scopes":["whiteboard:write:admin"],"x-granular-scopes":["whiteboard:update:whiteboard:admin"]}},"delete":{"tags":["Document"],"summary":"Delete a whiteboard","description":"Deletes a whiteboard.\n\n**[Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `whiteboard:write:admin`,`whiteboard:write`\n\n**[Granular Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `whiteboard:delete:whiteboard:admin`,`whiteboard:delete:whiteboard`\n\n**[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `MEDIUM`","operationId":"DeleteAWhiteboard","parameters":[{"name":"whiteboardId","in":"path","description":"The ID of the whiteboard.","required":true,"schema":{"type":"string","example":"HY8-AC_HSou4SXY1S-OmOg"}}],"responses":{"204":{"description":"**HTTP Status Code**: `204`   \n \nWhiteboard Deleted."},"400":{"description":"**HTTP Status Code:** `400` <br>\n Bad Request  \n\n "},"403":{"description":"**HTTP Status Code:** `403` <br>\n Forbidden  \n\n **Error Code:** `111804` <br>\n Permission is needed to access this document. <br>\n"},"429":{"description":"**HTTP Status Code:** `429` <br>\n Too Many Requests. For more information, see [rate limits](https://developers.zoom.us/docs/api/rest/rate-limits/). \n\n "}},"security":[{"openapi_oauth":["whiteboard:write:admin","whiteboard:write","whiteboard:delete:whiteboard:admin","whiteboard:delete:whiteboard"],"openapi_authorization":[]}],"x-extensions":{"x-permissions":["WhiteboardManagement:Edit"],"x-macro-scopes":["whiteboard:write:admin","whiteboard:write"],"x-granular-scopes":["whiteboard:delete:whiteboard:admin","whiteboard:delete:whiteboard"]}}},"/whiteboards/export":{"post":{"tags":["Export"],"summary":"Create whiteboard export","description":" Generates the export for the provided whiteboards. This process will generate a PDF of whiteboard projects along with an audit log, bundling them into a ZIP file.\n\n**[Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `whiteboard_export:write:admin`,`whiteboard_export:write`\n\n**[Granular Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `whiteboard:write:export`,`whiteboard:write:export:admin`\n\n**[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `MEDIUM`","operationId":"Createwhiteboardsexport","requestBody":{"content":{"application/json":{"schema":{"required":["whiteboard_ids"],"type":"object","properties":{"whiteboard_ids":{"maxItems":50,"minItems":1,"uniqueItems":true,"type":"array","description":"The list of whiteboard IDs. The list size must be **less than** 50, if more than 50, the API will **intercept** the first 50 IDs.","items":{"type":"string","description":"The ID of the whiteboard.","example":"HY8-AC_HSou4SXY1S-OmOg"}}}}}}},"responses":{"200":{"description":"**HTTP Status Code:** `200`    Successfully sent a request to generate whiteboard export","content":{"application/json":{"schema":{"required":["task_id"],"type":"object","properties":{"task_id":{"type":"string","description":"The unique identifier of the generated file, which expires is **30 days**. Use this task_id to query the progress of file generation (For more details, please refer to：[**Get whiteboard export generation status**](https://developers.zoom.us/docs/zoom-whiteboard/apis/#operation/Getwhiteboardexportdatagenerationstatus). Once the file is ready, you can download it using the user's OAuth token. For example: `https://{base_domain}/v2/whiteboards/export/task/{taskId} --header 'Authorization: Bearer {{OAuth-access-token}}` .","example":"f7f3cdd37bf74550afe7cdf79128a574"}}}}}},"400":{"description":"**HTTP Status Code:** `400` <br>\n Bad Request  \n\n "},"403":{"description":"**HTTP Status Code:** `403` <br>\n Forbidden  \n\n **Error Code:** `111804` <br>\n Permission is needed to access this document. <br>\n"},"404":{"description":"**HTTP Status Code:** `404` <br>\n Not Found  \n\n **Error Code:** `34002` <br>\n The whiteboard {whiteboard_id} not found. <br>\n"},"429":{"description":"**HTTP Status Code:** `429` <br>\n Too Many Requests. For more information, see [rate limits](https://developers.zoom.us/docs/api/rest/rate-limits/). \n\n "}},"security":[{"openapi_oauth":["whiteboard_export:write:admin","whiteboard_export:write","whiteboard:write:export","whiteboard:write:export:admin"],"openapi_authorization":[]}],"x-extensions":{"x-permissions":["WhiteboardContent:Read","WhiteboardManagement:Read"],"x-macro-scopes":["whiteboard_export:write:admin","whiteboard_export:write"],"x-granular-scopes":["whiteboard:write:export","whiteboard:write:export:admin"]}}},"/whiteboards/export/task/{taskId}":{"get":{"tags":["Export"],"summary":"Download whiteboard export","description":"Use this API to download the whiteboard export.\n\n**[Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `whiteboard_content:read:admin`,`whiteboard_content:read`\n\n**[Granular Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `whiteboard:read:export`,`whiteboard:read:export:admin`\n\n**[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `MEDIUM`","operationId":"Downloadwhiteboardexport","parameters":[{"name":"taskId","in":"path","description":"The unique identifier of the whiteboards file. The `task_id` generated by [**Create whiteboard export**](https://developers.zoom.us/docs/zoom-whiteboard/apis/#operation/Createwhiteboardsexport) interface.","required":true,"schema":{"type":"string","example":"f7f3cdd37bf74550afe7cdf79128a574"}}],"responses":{"200":{"description":"Returns a file stream, with the file type of ZIP."},"400":{"description":"**HTTP Status Code:** `400` <br>\n Bad Request  \n\n "},"404":{"description":"**HTTP Status Code:** `404` <br>\n Not Found  \n\n **Error Code:** `34002` <br>\n The task {task_id} not found. <br>\n"},"429":{"description":"**HTTP Status Code:** `429` <br>\n Too Many Requests. For more information, see [rate limits](https://developers.zoom.us/docs/api/rest/rate-limits/). \n\n "}},"security":[{"openapi_oauth":["whiteboard_content:read:admin","whiteboard_content:read","whiteboard:read:export","whiteboard:read:export:admin"],"openapi_authorization":[]}],"x-extensions":{"x-permissions":["WhiteboardContent:Read","WhiteboardManagement:Read"],"x-macro-scopes":["whiteboard_content:read:admin","whiteboard_content:read"],"x-granular-scopes":["whiteboard:read:export","whiteboard:read:export:admin"]}}},"/whiteboards/export/task/{taskId}/status":{"get":{"tags":["Export"],"summary":"Get whiteboard export generation status","description":"Use this API to query the status of the whiteboard export generation. Before using this API, confirm that you have invoked the interface for generating the whiteboard file  [**Create whiteboard export**](https://developers.zoom.us/docs/zoom-whiteboard/apis/#operation/Createwhiteboardsexport) and obtained the `task_id`.\n\n**[Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `whiteboard_content:read:admin`,`whiteboard_content:read`\n\n**[Granular Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `whiteboard:read:export`,`whiteboard:read:export:admin`\n\n**[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `MEDIUM`","operationId":"Getwhiteboardexportdatagenerationstatus","parameters":[{"name":"taskId","in":"path","description":"The unique identifier of the whiteboard export. ","required":true,"schema":{"type":"string","example":"adcc655d3a3549e692959737fe2a7a0d"}}],"responses":{"200":{"description":"Whiteboard export generation status.","content":{"application/json":{"schema":{"required":["status","total"],"type":"object","properties":{"processed":{"maxItems":50,"minItems":0,"type":"array","description":"List of processed whiteboard IDs.","items":{"type":"string","description":"The whiteboard ID.","example":"48Z4ppMfQJWONeVWFCcVzA"}},"status":{"type":"string","description":"Whiteboard export generation status. \n* Enum:\n* `processing` - Generating whiteboard export\n* `successed` - Whiteboard export generated successfully(as long as one is successful, it counts as a success)\n* `failed` - Whiteboard export generation failed","example":"processing","enum":["processing","successed","failed"],"x-enum-descriptions":["Generating whiteboard file","Whiteboard file generated successfully.","Whiteboard file generation failed"]},"total":{"type":"integer","description":"Total number of whiteboards requiring export generation.","example":3},"failed":{"maxItems":50,"minItems":0,"type":"array","description":"List of failed whiteboard IDs.","items":{"type":"string","description":"The whiteboard ID.","example":"UyKtcVj5REWMFT2qd-4qfg"}},"processing":{"maxItems":50,"minItems":0,"type":"array","description":"List of whiteboards being processed.","items":{"type":"string","description":"The whiteboard ID.","example":"r2Qr1q4hSxu03MG3hk03uA"}}}}}}},"400":{"description":"**HTTP Status Code:** `400` <br>\n Bad Request  \n\n "},"404":{"description":"**HTTP Status Code:** `404` <br>\n Not Found  \n\n **Error Code:** `34002` <br>\n The task {task_id} not found. <br>\n"},"429":{"description":"**HTTP Status Code:** `429` <br>\n Too Many Requests. For more information, see [rate limits](https://developers.zoom.us/docs/api/rest/rate-limits/). \n\n "}},"security":[{"openapi_oauth":["whiteboard_content:read:admin","whiteboard_content:read","whiteboard:read:export","whiteboard:read:export:admin"],"openapi_authorization":[]}],"x-extensions":{"x-permissions":["WhiteboardContent:Read","WhiteboardManagement:Read"],"x-macro-scopes":["whiteboard_content:read:admin","whiteboard_content:read"],"x-granular-scopes":["whiteboard:read:export","whiteboard:read:export:admin"]}}},"/whiteboards/files":{"post":{"tags":["File"],"summary":"Upload file for whiteboard import","description":"Uploads a file to whiteboard.\n**Notes**:\n- Base URL: `https://fileapi.zoom.us/v2`.\n- Rate limit: 20 requests per second per user or 2000 requests per second per IP address.\n- The caller must support HTTP 30x redirects.\n- The caller must retain the Authorization header when redirected to a different hostname.\n- Supported file formats: `.pdf`, `.vsdx`.\n- For an account-level [OAuth](https://developers.zoom.us/docs/integrations/create/) app, this API can only be used on behalf of a user who is assigned with a [role](https://support.zoom.com/hc/en/article?id=zm_kb&sysparm_article=KB0064983#h_80abad9b-86a8-492c-8a3b-5b0141a8c0a9) with **Edit** permission for Whiteboard Management.\n\n**[Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `whiteboard_file:write:admin`,`whiteboard_file:write`\n\n**[Granular Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `whiteboard:write:file`,`whiteboard:write:file:admin`\n\n**[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `HEAVY`\n\n**Not supported in Gov cluster** ","operationId":"Uploadfileforwhiteboardimport","requestBody":{"content":{"multipart/form-data":{"schema":{"required":["file"],"type":"object","properties":{"file":{"type":"string","description":"The upload file is in binary format. You can only send a maximum of 100 MB.","format":"binary","example":"Vm0wd2QyUXlVWGxWV0d4V1YwZDRWMVl3WkRSV01WbDNXa1JTVjAxV2JETlhhMUpUVmpBeFYySkVUbGhoTVVwVVZtcEJlRll5U2tWVWJHaG9UVlZ3VlZadGNFSmxSbGw1VTJ0V1ZXSkhhRzlVVmxaM1ZsWmFkR05GU214U2JHdzFWVEowVjFaWFNraGhSemxWVm14YU0xWnNXbUZrUjA1R1UyMTRVMkpIZHpGV1ZFb3dWakZhV0ZOcmFHaFNlbXhXVm0xNFlVMHhXbk5YYlVacVZtdGFNRlZ0ZUZOVWJVcEdZMFZ3VjJKVVJYZFpWRVpyVTBaT2NscEhjRlJTVlhCWlYxWlNSMlF5UmtkalJtUllZbFZhY2xWc1VrZFdiRnBZWlVaT1ZXSlZXVEpWYkZKSFZqSkZlVlZZWkZwbGEzQklXWHBHVDJSV1ZuUmhSazVzWWxob1dGWnRNSGRsUjBsNFUydGtXR0pIVWxsWmJGWmhZMVphZEdSSFJrNVNiRm93V2xWb2ExWXdNVVZTYTFwV1lrWktTRlpxUm1GU2JVbDZXa1prYUdFeGNHOVdha0poVkRKT2RGSnJhR2hTYXpWeldXeG9iMWRHV25STldHUlZUVlpHTTFSVmFHOWhiRXB6WTBac1dtSkdXbWhaTVZwaFpFZFNTRkpyTlZOaVJtOTNWMnhXYjJFeFdYZE5WVlpUWVRGd1YxbHJXa3RUUmxweFVtMUdVMkpWYkRaWGExcHJZVWRGZUdOSE9WZGhhMHBvVmtSS1QyUkdTbkpoUjJoVFlYcFdlbGRYZUc5aU1XUkhWMjVTVGxOSGFGQlZiVEUwVmpGU1ZtRkhPVmhTTUhCNVZHeGFjMWR0U2tkWGJXaGFUVzVvV0ZreFdrZFdWa3B6VkdzMVYwMVZiekZXYlhCTFRrWlJlRmRzYUZSaVJuQlpWbXRXZDFZeGJISlhhM1JVVW14d2VGVnRNVWRWTWtwV1lrUmFXR0V4Y0hKWlZXUkdaVWRPU0U5V1pHaGhNSEJ2Vm10U1MxUXlVa2RUYmtwb1VqSm9WRmxZY0ZkbGJHUllaVWM1YVUxWFVraFdNalZUVkd4a1NGVnNXbFZXYkhCSVZGUkdVMVp0UmtoUFYyaHBVbGhDTmxkVVFtRmpNV1IwVTJ0a1dHSlhhR0ZVVnpWdlYwWnJlRmRyWkZkV2EzQjZWa2R6TVZkR1NsWmpSV3hYWWxoQ1RGUnJXbEpsUm1SellVWlNhRTFzU25oV1Z6QjRUa2RHUjFaWVpHaFNWVFZWVlcxNGQyVkdWblJOVldSV1RXdHdWMWxyVW1GWFIwVjRZMGhLV2xaWFVrZGFWV1JQVTBVNVYxcEhhR2hOU0VKMlZtMTBVMU14VVhsVmEyUlVZbXR3YjFWcVNtOVdSbXhaWTBaa2JHSkhVbGxhVldNMVlWVXhXRlZyYUZkTmFsWlVWa2Q0VDFOSFJrZFJiRnBwVmtWVmQxWnRjRWRWTVZwMFVtdG9VRlp0YUZSVVZXaERUbFphU0dWSFJtcE5WMUl3VlRKMGExZEhTbGhoUjBaVlZucFdkbFl3V25KbFJtUnlXa1prVjJFelFqWldhMlI2VFZaa1IxTnNXbXBTVjNoWVdXeG9RMVJHVW5KWGJFcHNVbTFTZWxsVldsTmhSVEZ6VTI1b1YxWjZSVEJhUkVaclVqSktTVlJ0YUZOaGVsWlFWa1phWVdReVZrZFdXR3hyVWtWS1dGUldXbmRsVm10M1YyNWtXRkl3VmpSWk1GSlBWakpHY2xkcmVGZGhhM0JRVlRGa1MxSXhjRWRhUms1WFYwVktNbFp0TVRCVk1VMTRWVmhzVlZkSGVGWlpWRVozWWpGV2NWUnJUbGRTYlhoYVdUQmFhMWRHV25OalJteGFUVVpWTVZsV1ZYaGpiVXBGVld4a1RtRnNXbFZXYTJRMFlURk9SMVp1VGxoaVJscFlXV3RvUTFkV1draGtSMFpYWWxaYVNWVnRkRzlWUmxsNVlVaENWbUpIYUVSVWJYaHJWbFpHZEZKdGNFNVdNVWwzVmxSS01HRXhaRWhUYkdob1VqQmFWbFp1Y0Zka2JGbDNWMjVLYkZKdFVubFhhMXByVmpKRmVsRnFXbGRoTWxJMlZGWmFXbVF3TVZkWGJXeHNZVEZ3V1ZkWGVHOVJNVTE0Vld4a1lWSldjSE5WYlRGVFYyeGtjbFpVUmxkTlZuQjZXVEJhVjFkR1dYcFZia3BYVmtWYWVsWnFSbGRqTVdSellVZHNWMVp1UWxGV2ExcGhXVmRSZVZaclpGZFhSM2h5Vld0V1MxZEdVbGRYYm1Sc1ZtMTBNMVl5Tld0WFJrbDNWbXBTV2sxSGFFeFdNbmhoVjBaV2NscEhSbGRXTVVwUlZsZHdTMU14U1hsU2EyaG9VbFJXV0ZsdGRFdE5iRnAwVFZSQ1ZrMVZNVFJXVnpWVFZqSkZlVlZ1UmxaaVIxRXdWbTE0YzJNeGNFaFBWbVJUWWtWd1dsWkhlR3BPVmxsNFYyNU9hbEpYYUZsV2ExVXhaR3hzVjFaWWFGaFNiRm94V1RCYWExUnNXWGxoUkVwWFRWWndhRlY2UmtwbFJsSjFWbXhLYVZKc2NGbFdSbEpIVXpBMWMxZHJhR3hTTUZwaFZtcEdTMUl4VW5OWGJVWldVbXh3TUZaWE5VTldNa3BJWVVWU1ZrMVdjR2haTVZwUFkxWldjMWRyTlZkTlZXd3pWbXhTUzAxSFJYaGFSV2hVWWtkb2IxVnFRbUZXYkZwMVkwWmthMkpHYkROV01qVkxZa1pLZEZWdWJGaGhNWEJ5Vm1wS1JtVnNSbkZYYkdSb1RXeEpNbFpHV21GWGJWRjNUVlprV0dKWGVITlpWRVozVjFaa1dHVkhPVkpOVmtwSVZsYzFTMWRIU2taalNFNVdZbFJHVkZwWGVITldiR1J6Vkcxb1YyRXpRWGhXVm1NeFlqRlplRmRZY0doVFJYQllWbXRXWVdWc1duRlNiR1JxVFZkU2VsbFZaSE5XTVZwMVVXeEdWMkV4Y0doWFZtUlNaVlphY2xwR1pGaFNNMmg1VmxkMFYxTXhaRWRWYkdSWVltMVNjMVp0TVRCTk1WbDVUbGQwV0ZKcmJETldiWEJUVjJzeFNHRkZlRmROYm1ob1ZqQmFWMk5zY0VoU2JHUlhUVlZ3VWxac1pIZFRNVTE0VTFoc1UyRXlhRzlWYkZKWFYwWnNkR1JGZEU1aVJuQXdWRlpTUTFack1WWk5WRkpYVm0xb2VsWnNXbXRUUjFaSFYyeHdWMUpXYjNwWFZsWmhWakpPVjFSdVVsQldiVkpVV1d0V2QxZHNXa2hsUjNCUFZteHNORll5TlU5aGJFcFlZVVpzVjJFeFZYaGFSM2h6VmpGYVdXRkhjR2xXV0VKSFZteGtOR0V4VW5OWFdHeG9Va1Z3V0ZsWGRFdGpiRlkyVW10MGFtRjZWbGhYYTFwaFlWWktjMk5HYkZoV00yaG9WVzB4VW1WR1pIVlZiWEJUVmpGS1dGWkdXbUZrTURGSFZtNVNhMUo2YkZkVmJYaDNUVVpzVmxkc1RsZFdiSEJaV1ZWV1UxWlhTa2RqUjJoV1RVZFNXRlV3V2t0a1IwNUdUbFprVGxaWGQzcFdiWGhUVXpBeFNGTlliRk5oTWxKVldXMXpNVlpXYkhKYVJ6bFhZa1p3ZWxZeU5XdFVhekZYWTBoc1YwMXFSa2haVjNoaFkyczFXV0pHYUdoTldFSlJWMVphWVZNeVRuUlVhMVpZWWtkU2NGVnFRVEJOUm1SWlkwVmtWMkpXUmpOVVZsWnpZVVpLY2s1WE9WcGhNbWhFVmpGYWExWXhjRVZSYlhScFZtdFpNRlpxU2pSV01WVjVVMnRrYWxORk5WZFpiRkpIVmtaU1YxZHNXbXhXTURReVZXMTRiMVV5UlhwUmJVWlhWbTFOZUZscVJscGxSbVJaWTBkb1ZGSllRbGRYVmxKTFZURk9SMVp1UmxOaVZWcFpWbTAxUTFOV2JGWlhhemxYVFZad1NGWXllR3RXTWtwSVZHcFNWV0V5VWxOYVZscGhZMnh3UjFwR2FGTk5NbWcxVm14a2QxRXhiRmhVYTJSWFlteEtjMVV3WkZOak1XeHlWMjVPVDFadVFsZFpWV1F3VjBaS2NtSkVUbGRpV0VKVVZqSnplRkl4VG5OUmJHUk9ZV3RhU0Zkc1dtRldNazV6WTBWb1UySkhVazlVVnpGdlUyeFplRlZyY0d4U2F6RTBWVEZvYjJGc1NsaGhTRUpXWWxSR2RsWnJXbUZqTWtaR1ZHeFNUbFp1UVhkV1JscFRVVEZhY2sxV1drNVdSa3BZV1d0a2IyUnNXWGRYYlhSVVVqQmFTRmxyV25kaFZtUklZVWM1VjJKVVJUQlpla3BQWXpKT1JtRkdRbGROTUVwVlYxZDBiMUV3TlVkWGJrcGFUVEpTVUZadGVITk9SbGw1VGxVNWFHSkZjRmxaVlZwelZqSkZlRlpZYUdGU00yaDZWbXBHWVZkWFJrZGhSazVwVW01Qk1WWXhXbGRaVjBWNFZXNVNVMkpyTlZsWmExcGhWMFpzVlZOc1NrNVNiVkpZVmpKME1HRnJNVmRUYWtaWFVucEdkbFpVU2t0U01rNUhZa1prVTJKRmNFMVhWM0JIVkRGWmVGcElTbWhTTTJoVVZGVmFkMkZHV25STlNHaFdUVlZzTkZaWE5VOVhSMHBXVjJ4a1ZtSllhRE5VVlZwelZteGtjMVJzWkZkaVNFSlpWMVJDYTFJeFdsZFhiazVxVWpKb1lWcFhkR0ZOTVZaelYyeGthMUl3TlVkVWJGcHJWR3hhV0dRemNGZGlXR2hVVlhwQmVGTkdTbGxoUjBaVFZqSm9WbGRYZEd0aU1rbDRWbTVHVW1KVldsaFphMXAzVFVad1ZtRkhkRlZoZWtaWVdUQm9jMVl3TVhGU2EyaGFWak5vYUZreU1VOVNWa1owVW14T1YwMVZXWHBXYlRGM1V6Rk5lVlJ1VGxWaWEzQnZWVzB4VTFaR1VsVlRiVGxwVFZad2VWWlhkREJWTURGWFlrUlNWMUo2VmxoV2JURkxVbXhPYzJGR1dtbFNhM0JaVm1wR1lWbFdTWGhpUkZwVFlsZDRUMVpxUmt0VFZtUllaRWRHVjAxV1ducFhhMVp2WVVaS2MxTnNXbGRpVkVaVVZtdGFkMWRIVmtsVWJHUnBVakZLTmxaclkzaGlNVlY0VjJ0YVdHRnNjRmhXYTFaeVpVWnNjVkpzY0d4U2JWSmFXVEJhWVdGV1NYbGhSbkJYWWxSRk1GcEVSbk5XTWs1SFYyeG9hVmRHU25sV2JURXdaREpXYzFkdVVrNVhSVFZZVkZaV2MwNXNiRlpWYkdSWFRVUkdXVlpXYUd0WFJscDBWV3hPWVZac2NHaFpNbmgzVWpGd1NHSkhiRk5YUlVreFZtMTRhMDFHV1hoVVdHeFVWMGRvY0ZWdE1UUmpWbFp6V2taT2FrMVdjREJhVlZZd1lrZEtSMk5FUWxWV1ZrcFlWakJhU21ReVRrWmhSbkJPVW01Q01sWnFTbnBsUms1SVVtdGFiRkp0VWs5WmJURnZZakZhY1ZGdFJsZE5helY2V1RCV2IxVXlTa2hWYXpsVlZucEdkbFV5ZUZwbFJsWnlZMGQ0VTJGNlJUQldWRVp2WWpKR2MxTnNhRlppVjJoWFdXeG9UbVZHV1hkWGJIQnJUVlp3ZVZwRlZURmhWa3AxVVZoa1dGWkZTbGhaVkVacll6RmtXVnBHWkdoaVJYQlpWMWQwYTJJeVVuTlhXR1JZWWxoU1ZWVnFRbUZUUmxsNVpVaGthRlp0VWtsWlZXTTFWakpLVlZKVVFscGxhM0JRV1hwR2QxTldUblJrUms1T1RVVndWbFl4WkRCWlYxRjNUbFZrV0dKSGFFOVdhMVpMVkRGV2RHVklUazlTYkd3MVZHeFZOV0ZIU2taalJteGFWbFp3ZGxacVNrZGphelZYVld4a1UxWnVRalpXYlhoaFVqRmtXRkpyWkZWaVIxSnZWRlJDU2sxc1duUmtSM1JQVW0xNFdGWnNhSE5XUjBWNFkwWnNWMDFIYUVSV01GcGhZekZrZFZwR1RrNVdhMWt3Vm1wS01GUXhXblJUYTFwVVlrWndWbFpzV2tkTk1WWkhVbFJzVVZWVU1Eaz0="}}}}}},"responses":{"201":{"description":"File successfully uploaded.","content":{"application/json":{"schema":{"type":"object","properties":{"file_id":{"type":"string","description":"The file's unique ID.","example":"xBvggqyjQUal6TecwMlYwE"}}}}}},"400":{"description":"**HTTP Status Code:** `400` <br>\n Bad Request  \n\n **Error Code:** `124` <br>\n Invalid access token. <br>\n**Error Code:** `300` <br>\n Invalid File type.\nExceed max file size: ${maxSize} megabytes. <br>\n"},"429":{"description":"**HTTP Status Code:** `429` <br>\n Too Many Requests  For more information, see [rate limits](https://developers.zoom.us/docs/api/rate-limits/). \n\n "}},"security":[{"openapi_oauth":["whiteboard_file:write:admin","whiteboard_file:write","whiteboard:write:file","whiteboard:write:file:admin"],"openapi_authorization":[]}],"x-extensions":{"x-permissions":["WhiteboardManagement:Edit"],"x-macro-scopes":["whiteboard_file:write:admin","whiteboard_file:write"],"x-granular-scopes":["whiteboard:write:file","whiteboard:write:file:admin"]}}},"/whiteboards/{whiteboardId}/files/{fileId}":{"get":{"tags":["File"],"summary":"Download Imported Whiteboard File","description":"Download files imported into the whiteboard, including images, PDFs, DOCX, and other supported formats.\n\n**[Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `whiteboard_file:read`,`whiteboard_file:read:admin`\n\n**[Granular Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `whiteboard:read:file`,`whiteboard:read:file:admin`\n\n**[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `LIGHT`","operationId":"Downloadembeddedwhiteboardfile","parameters":[{"name":"whiteboardId","in":"path","description":"The whiteboard ID.","required":true,"schema":{"type":"string","example":"YXw46hQqQCiZMlAGkQVKsA"}},{"name":"fileId","in":"path","description":"The ID of the file imported into the whiteboard to download.","required":true,"schema":{"type":"string","example":"Et2l7DAvQqu5E6jsqnnasw"}}],"responses":{"200":{"description":"Returns a file stream."},"403":{"description":"**HTTP Status Code:** `403` <br>\n Forbidden  \n\n "},"404":{"description":"**HTTP Status Code:** `404` <br>\n Not Found  \n\n "},"429":{"description":"**HTTP Status Code:** `429` <br>\n Too Many Requests. For more information, see [rate limits](https://developers.zoom.us/docs/api/rate-limits/). \n\n "}},"security":[{"openapi_oauth":["whiteboard_file:read","whiteboard_file:read:admin","whiteboard:read:file","whiteboard:read:file:admin"],"openapi_authorization":[]}],"x-extensions":{"x-permissions":["WhiteboardContent:Read"],"x-macro-scopes":["whiteboard_file:read","whiteboard_file:read:admin"],"x-granular-scopes":["whiteboard:read:file","whiteboard:read:file:admin"]}}},"/whiteboards/import":{"post":{"tags":["Import"],"summary":"Create a new whiteboard by import","description":"Creates a new whiteboard for a user by converting Miro, Mural, or Visio files.\n\n**[Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `whiteboard_import:write`,`whiteboard_import:write:admin`\n\n**[Granular Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `whiteboard:write:import`,`whiteboard:write:import:admin`\n\n**[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `HEAVY`\n\n**Not supported in Gov cluster** ","operationId":"CreateWhiteboardImport","requestBody":{"description":"Creates a new whiteboard for a user by converting Miro, Mural, or Visio files request form-data.","content":{"application/json":{"schema":{"required":["file_id","type"],"type":"object","properties":{"file_id":{"type":"string","description":"The ID of the file to convert to a whiteboard. Use the **Upload File for Whiteboard Import** API (POST `/whiteboards/files`) to upload the file and get the `file_id`.\nSupported file types:\n- **Visio**: `.vsdx`\n- **Miro** and **Mural**: `.pdf`\n\nMaximum file size: **100 MB**.\nEnsure the file is valid, within the size limit, and in one of the supported formats.","example":"xBvggqyjQUal6TecwMlYwE"},"type":{"type":"number","description":"The import file original type. \n\nEnum:  \n* `1` - Miro \n* `2` - Visio \n* `3` - Mural ","example":1},"whiteboard_name":{"type":"string","description":"The name of the whiteboard created by import.","example":"Q1 plan"},"skip_notifications":{"type":"boolean","description":" **Default is false (notifications will be sent)**.\n If set to `true`, collaborators and owners will not receive direct messages or emails when the whiteboard is imported.","example":false},"owner_email":{"type":"string","description":"The owner email. This field is only available if you have the `whiteboard:write:import:admin` scope. Otherwise, it will automatically be set to `null` and the document owner will **default to the user who imported the file**.","format":"email","example":"example@zoom.us"},"collaborators":{"maxItems":100,"minItems":0,"type":"array","description":"Users or team chat channels to add to a whiteboard.","items":{"type":"object","properties":{"email":{"type":"string","description":"The `user email` address to share with.","format":"email","example":"user@example.com"},"role":{"type":"string","description":"Collaborator role type. \n\nEnum:  \n- `0` - OWNER \n- `1` - CO_OWNER \n- `2` - EDITOR \n- `3` - COMMENTER \n- `4` - VIEWER","example":"2","enum":["0","1","2","3","4"]},"channel_id":{"type":"string","description":"The team chat `channel ID` to share with.","example":"cabc1234567defghijkl01234"}},"description":"Array of collaborator objects."}},"project_id":{"type":"string","description":"qiMWddmtRxqwSFrK22lJPg","example":"The Project ID"}}}}}},"responses":{"201":{"description":"The imported file is being converted into a whiteboard.","content":{"application/json":{"schema":{"type":"object","properties":{"task_id":{"type":"string","description":"Use this ID to check the import status via the [Get Whiteboard Import Status](https://developers.zoom.us/docs/api/whiteboard/#tag/import/GET/whiteboards/import/task/{taskId}/status) endpoint (GET `/whiteboards/import/{taskId}/status`). The unique ID for your import.","example":"ce31de9e5a5f440bab9d60c144fd76b7"}}}}}},"400":{"description":"**HTTP Status Code:** `400` <br>\n Bad Request  \n\n **Error Code:** `34002` <br>\n Invalid file type. <br>\n**Error Code:** `38003` <br>\n File size exceed limit. <br>\n**Error Code:** `38004` <br>\n Conversion settings are not enabled. Please contact your account administrator to allow users to import and convert boards and diagrams from other applications into editable whiteboards via the whiteboard account settings. <br>\n"},"429":{"description":"**HTTP Status Code:** `429` <br>\n Too Many Requests. For more information, see [rate limits](https://developers.zoom.us/docs/api/rest/rate-limits/). \n\n "}},"security":[{"openapi_oauth":["whiteboard_import:write","whiteboard_import:write:admin","whiteboard:write:import","whiteboard:write:import:admin"],"openapi_authorization":[]}],"x-extensions":{"x-permissions":["WhiteboardManagement:Edit"],"x-macro-scopes":["whiteboard_import:write","whiteboard_import:write:admin"],"x-granular-scopes":["whiteboard:write:import","whiteboard:write:import:admin"]}}},"/whiteboards/import/{taskId}/status":{"get":{"tags":["Import"],"summary":"Get whiteboard import status ","description":"Use this API to query the status of new whiteboard by import. Before using this API, confirm that you have invoked the interface for import file to create new whiteboard **Create a new whiteboard by import** and obtained the `task_id`.\n\n**[Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `whiteboard_import:read`,`whiteboard_import:read:admin`\n\n**[Granular Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `whiteboard:read:import:admin`,`whiteboard:read:import`\n\n**[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `LIGHT`","operationId":"GetWhiteboardimportstatus","parameters":[{"name":"taskId","in":"path","description":"The unique ID for your import.","required":true,"schema":{"type":"string","example":"ce31de9e5a5f440bab9d60c144fd76b7"}}],"responses":{"200":{"description":"Get whiteboards import result.","content":{"application/json":{"schema":{"type":"object","properties":{"file_name":{"type":"string","description":"The file name of import file.","example":"miro.pdf"},"status":{"type":"string","description":"\nThe status of the whiteboard created by importing a file.\n\n**Enum**:\n- `processing` - The file is converting to whiteboard.\n- `succeeded` - The file convert to whiteboard successfully.\n- `failed` - The file convert to whiteboard failed.\n","example":"succeeded","default":"processing","enum":["processing","failed","succeeded"]},"whiteboard_id":{"type":"string","description":"The whiteboard ID `nullable`. This value is returned only when the `status` is `succeeded`.","example":"HY8-AC_HSou4SXY1S-OmOg"},"doc_name":{"type":"string","description":"The whiteboard name `nullable`. This value is returned only when the `status` is `succeeded`.","example":"Q1 Plan"}}}}}},"400":{"description":"**HTTP Status Code:** `400` <br>\n Bad Request  \n\n **Error Code:** `38002` <br>\n Failed to convert the file {fileName}. <br>\n"},"404":{"description":"**HTTP Status Code:** `404` <br>\n Not Found  \n\n **Error Code:** `38007` <br>\n The taskId not exist or expired. <br>\n"},"429":{"description":"**HTTP Status Code:** `429` <br>\n Too Many Requests. For more information, see [rate limits](https://developers.zoom.us/docs/api/rest/rate-limits/). \n\n "}},"security":[{"openapi_oauth":["whiteboard_import:read","whiteboard_import:read:admin","whiteboard:read:import:admin","whiteboard:read:import"],"openapi_authorization":[]}],"x-extensions":{"x-permissions":["WhiteboardManagement:Edit"],"x-macro-scopes":["whiteboard_import:read","whiteboard_import:read:admin"],"x-granular-scopes":["whiteboard:read:import:admin","whiteboard:read:import"]}}},"/whiteboards/projects":{"get":{"tags":["Project"],"summary":"List all projects","description":"Retrieves a list of projects.\n\n**[Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `whiteboard_project:read`,`whiteboard_project:read:admin`\n\n**[Granular Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `whiteboard:read:list_projects:admin`,`whiteboard:read:list_projects`\n\n**[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `LIGHT`\n\n**Not supported in Gov cluster** ","operationId":"Listallprojects","parameters":[{"name":"search_key","in":"query","description":"The name of a project. If this parameter is provided, only the matched project will be returned. Otherwise, all projets will be returned.","required":false,"schema":{"maxLength":50,"minLength":0,"type":"string","example":"demo "}},{"name":"user_id","in":"query","description":"The email address or user ID of the project owner. If this parameter is provided, only the project owned by the provided user will be returned. If set to `me`, will return the matched projects of current user.","required":false,"schema":{"type":"string","example":"me"}},{"name":"page_size","in":"query","description":"The number of records returned from a single API call.","required":false,"schema":{"type":"integer","example":10}},{"name":"next_page_token","in":"query","description":"The next page token is used to paginate through large result sets. A next page token will be returned whenever the set of available results exceeds the current page size. The expiration period for this token is 15 minutes.","required":false,"schema":{"type":"string","example":"R4aF9Oj0fVM2hhezJTEmSKaBSkfesDwGy42"}}],"responses":{"200":{"description":"The list of projects is successfully retrieved.","content":{"application/json":{"schema":{"type":"object","properties":{"projects":{"type":"array","description":"The project list.","items":{"type":"object","properties":{"collaborator":{"maxItems":100,"minItems":0,"type":"array","description":"The project collaborators, this API returns only the project collaborators who have the 'owner' role, along with the current user's information.","items":{"type":"object","properties":{"collaborator_id":{"type":"string","description":"The project collaborator ID.","example":"x4g6hy789k0o878k"},"collaborator_name":{"type":"string","description":"The project collaborator name.","example":"Jack"},"user_id":{"type":"string","description":"`nullable` User ID. This response only returns if the `collaborator_type` is 0. If the `collaborator_type` is not 0, this returns null value.","example":"wf3h7uo1dk0v53bl"},"avatar":{"type":"string","description":"Collaborator profile picture.","example":"https://content.zoom.us/swerwerw.jpeg"},"role":{"type":"integer","description":"Collaborator role type.\n\nRole Enum Values:\n\n- `0` - OWNER\n- `1` - CO_OWNER\n- `2` - EDITOR\n- `3` - COMMENTER\n- `4` - VIEWER","example":2,"enum":[0,1,2,3,4]},"collaborator_type":{"type":"integer","description":"Collaborator type.\nEnum:\n- `0` - SAME_ACCOUNT_USER\n- `1` - EXTERNAL_USER","example":0,"enum":[0,1]}},"description":"The project collaborator information"}},"created_date":{"type":"string","description":"The project create date-time in UTC/GMT. Example: `2020-03-31T12:02:00Z`","format":"date-time","example":"2020-03-31T12:02:00Z"},"modified_date":{"type":"string","description":"The project update date-time in UTC/GMT. Example: `2020-03-31T12:02:00Z`","format":"date-time","example":"2020-03-31T12:02:00Z"},"project_name":{"type":"string","description":"The  project name.","example":"Untitle"},"project_id":{"type":"string","description":"The Project ID","example":"qiMWddmtRxqwSFrK22lJPg"},"starred":{"type":"boolean","description":"Indicates whether the project is starred.\n`true`: starred\n`false`: not starred","example":false},"owner_display_name":{"type":"string","description":"The project owner display name.","example":"Example Name"},"project_link":{"type":"string","description":"The project redirect link.","example":"https://zoom.us/wb#/project/i1Ts2cRpSASonwbvTiPlUQ"}},"description":"The project basic info."}},"next_page_token":{"type":"string","description":"The next page token paginates through a large set of results. A next page token is returned when the available results exceed the current page size. The expiration period for this token is 15 minutes.","example":"qUEQqB1V0HVhJmwKFQrGOD"},"page_size":{"type":"integer","description":"The number of records returned per page in a single API call.","example":10},"total_records":{"type":"integer","description":"The total number of records found.","example":100}}}}}},"429":{"description":"**HTTP Status Code:** `429` <br>\n Too Many Requests. For more information, see [rate limits](https://developers.zoom.us/docs/api/rate-limits/). \n\n "}},"security":[{"openapi_oauth":["whiteboard_project:read","whiteboard_project:read:admin","whiteboard:read:list_projects:admin","whiteboard:read:list_projects"],"openapi_authorization":[]}],"x-extensions":{"x-permissions":["WhiteboardManagement:Read"],"x-macro-scopes":["whiteboard_project:read","whiteboard_project:read:admin"],"x-granular-scopes":["whiteboard:read:list_projects:admin","whiteboard:read:list_projects"]}},"post":{"tags":["Project"],"summary":"Create a new project","description":"This API endpoint allows you to create a new project for a user, optionally adding collaborators and initializing it with existing whiteboards.\n\n**[Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `whiteboard_project:write`,`whiteboard_project:write:admin`\n\n**[Granular Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `whiteboard:write:project`,`whiteboard:write:project:admin`\n\n**[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `LIGHT`","operationId":"Createproject","requestBody":{"content":{"application/json":{"schema":{"required":["project_name"],"type":"object","properties":{"project_name":{"maxLength":50,"minLength":1,"type":"string","description":"The project name.","example":"Untitle"},"skip_notifications":{"type":"boolean","description":" **Default is false (notifications will be sent)**.\n If set to `true`, collaborators and owners will not receive direct messages or emails when the project is created.","example":false},"invite_message":{"maxLength":280,"minLength":0,"type":"string","description":"The invite message.","example":"I'm glad to invite you to join this project."},"collaborators":{"title":"Array of collaborator objects.","maxItems":100,"minItems":0,"type":"array","description":"Array of collaborator objects to be added to the project.","items":{"type":"object","properties":{"email":{"type":"string","description":"The user's email to be added to the project.","example":"user@example.com"},"role":{"type":"integer","description":"Collaborator role type.\nWhen assigning a new `OWNER` or `CO_OWNER`, the specified user must belong to the same account as the original `OWNER`. If a new owner is designated for a project, the original owner will automatically be demoted to `CO_OWNER`.\n\nRole Enum Values:\n\n- `0` - OWNER\n- `1` - CO_OWNER\n- `2` - EDITOR\n- `3` - COMMENTER\n- `4` - VIEWER","example":2,"default":2,"enum":[0,1,2,3,4]}},"description":"A user who works jointly on a project."}},"whiteboard_ids":{"title":"whiteboard_id","maxItems":50,"minItems":0,"uniqueItems":true,"type":"array","description":"The whiteboard ID list that you want to add to the project.","items":{"type":"string","description":"The whiteboard ID.","example":"J7XZFDEQTkWSsMsmO_M1Xa"}},"owner_email":{"type":"string","description":"The owner email. This field is only available if you have the `whiteboard_project:write:admin` scope. Otherwise, it will automatically be set to `null` and the project owner will default to the request user.","format":"email","example":"owner@example.com"}}}}}},"responses":{"201":{"description":"The project has been successfully created.","content":{"application/json":{"schema":{"type":"object","properties":{"collaborator":{"maxItems":100,"minItems":0,"type":"array","description":"The project collaborators.","items":{"type":"object","properties":{"collaborator_id":{"type":"string","description":"The project collaborator ID.","example":"x4g6hy789k0o878k"},"collaborator_name":{"type":"string","description":"The project collaborator name.","example":"Jack"},"user_id":{"type":"string","description":"`nullable` User ID. This response only returns if the `collaborator_type` is 0. If the `collaborator_type` is not 0, this returns null value.","example":"wf3h7uo1dk0v53bl"},"avatar":{"type":"string","description":"Collaborator profile picture.","example":"https://content.zoom.us/swerwerw.jpeg"},"role":{"type":"integer","description":"Collaborator role type.\n\nRole Enum Values:\n\n- `0` - OWNER\n- `1` - CO_OWNER\n- `2` - EDITOR\n- `3` - COMMENTER\n- `4` - VIEWER","example":2,"enum":[0,1,2,3,4]},"collaborator_type":{"type":"integer","description":"Collaborator type.\nEnum:\n- `0` - SAME_ACCOUNT_USER\n- `1` - EXTERNAL_USER","example":0,"enum":[0,1]}},"description":"The project collaborator information."}},"created_date":{"type":"string","description":"The project creation date-time in UTC/GMT. Example: `2020-03-31T12:02:00Z`.","format":"date-time","example":"2020-03-31T12:02:00Z"},"modified_date":{"type":"string","description":"The whiteboard update date-time in UTC/GMT. Example: `2020-03-31T12:02:00Z`.","format":"date-time","example":"2020-03-31T12:02:00Z"},"project_name":{"type":"string","description":"The project name.","example":"Untitle"},"project_id":{"type":"string","description":"The Project ID","example":"qiMWddmtRxqwSFrK22lJPg"},"starred":{"type":"boolean","description":"Indicates whether the project is starred. `true`: starred, `false`: not starred.","example":false},"project_link":{"type":"string","description":"The project redirect link.","example":"https://zoom.us/wb#/project/i1Ts2cRpSASonwbvTiPlUQ"}}}}}},"400":{"description":"**HTTP Status Code:** `400` <br>\n Bad Request  \n\n "},"429":{"description":"**HTTP Status Code:** `429` <br>\n Too Many Requests. For more information, see [rate limits](https://developers.zoom.us/docs/api/rate-limits/). \n\n "}},"security":[{"openapi_oauth":["whiteboard_project:write","whiteboard_project:write:admin","whiteboard:write:project","whiteboard:write:project:admin"],"openapi_authorization":[]}],"x-extensions":{"x-permissions":["WhiteboardManagement:Edit"],"x-macro-scopes":["whiteboard_project:write","whiteboard_project:write:admin"],"x-granular-scopes":["whiteboard:write:project","whiteboard:write:project:admin"]}}},"/whiteboards/projects/{projectId}":{"get":{"tags":["Project"],"summary":"Get a project","description":"Retrieves detailed information about a specific project.\n\n**[Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `whiteboard_project:read`,`whiteboard_project:read:admin`\n\n**[Granular Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `whiteboard:read:project`,`whiteboard:read:project:admin`\n\n**[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `LIGHT`","operationId":"Getaproject","parameters":[{"name":"projectId","in":"path","description":"The project ID.","required":true,"schema":{"type":"string","example":"N6XZFDEQTkWSsMsmO_M1XQ"}}],"responses":{"200":{"description":"The project information has been successfully retrieved.","content":{"application/json":{"schema":{"type":"object","properties":{"collaborator":{"maxItems":100,"minItems":0,"type":"array","description":"The project collaborators. This API returns only the project collaborators who have the 'owner' role, along with the current user's information.","items":{"type":"object","properties":{"collaborator_id":{"type":"string","description":"The project collaborator ID.","example":"x4g6hy789k0o878k"},"collaborator_name":{"type":"string","description":"The project collaborator name.","example":"Jack"},"user_id":{"type":"string","description":"`nullable` User ID. This response only returns if the `collaborator_type` is 0. If the `collaborator_type` is not 0, this returns null value.","example":"wf3h7uo1dk0v53bl"},"avatar":{"type":"string","description":"Collaborator profile picture.","example":"https://content.zoom.us/swerwerw.jpeg"},"role":{"type":"integer","description":"Collaborator role type.\n\nRole Enum Values:\n\n- `0` - OWNER\n- `1` - CO_OWNER\n- `2` - EDITOR\n- `3` - COMMENTER\n- `4` - VIEWER","example":2,"enum":[0,1,2,3,4]},"collaborator_type":{"type":"integer","description":"Collaborator type.\nEnum:\n- `0` - SAME_ACCOUNT_USER\n- `1` - EXTERNAL_USER","example":0,"enum":[0,1]}},"description":"The project collaborator information."}},"created_date":{"type":"string","description":"The project create date-time in UTC/GMT. Example: `2020-03-31T12:02:00Z`","format":"date-time","example":"2020-03-31T12:02:00Z"},"modified_date":{"type":"string","description":"The project update date-time in UTC/GMT. Example: `2020-03-31T12:02:00Z`","format":"date-time","example":"2020-03-31T12:02:00Z"},"project_name":{"type":"string","description":"The  project name.","example":"Untitle"},"project_id":{"type":"string","description":"The Project ID","example":"qiMWddmtRxqwSFrK22lJPg"},"starred":{"type":"boolean","description":"Indicates whether the project is starred.\n`true`: starred\n`false`: not starred","example":false},"owner_display_name":{"type":"string","description":"The project owner display name.","example":"Example Name"},"project_link":{"type":"string","description":"The project redirect link.","example":"https://zoom.us/wb#/project/i1Ts2cRpSASonwbvTiPlUQ"},"parent_project_id":{"type":"string","description":"The ID of the parent project. This field is only populated when the current project is a subproject; otherwise, it will be null.","example":"parent123abc"}}}}}},"403":{"description":"**HTTP Status Code:** `403` <br>\n Forbidden  \n\n **Error Code:** `111804` <br>\n Permission is needed to access this project. <br>\n"},"404":{"description":"**HTTP Status Code:** `404` <br>\n Not Found  \n\n **Error Code:** `38007` <br>\n The projectId is not exist. <br>\n"},"429":{"description":"**HTTP Status Code:** `429` <br>\n Too Many Requests. For more information, see [rate limits](https://developers.zoom.us/docs/api/rate-limits/). \n\n "}},"security":[{"openapi_oauth":["whiteboard_project:read","whiteboard_project:read:admin","whiteboard:read:project","whiteboard:read:project:admin"],"openapi_authorization":[]}],"x-extensions":{"x-permissions":["WhiteboardManagement:Read"],"x-macro-scopes":["whiteboard_project:read","whiteboard_project:read:admin"],"x-granular-scopes":["whiteboard:read:project","whiteboard:read:project:admin"]}},"delete":{"tags":["Project"],"summary":"Delete a project","description":"This API endpoint allows you to delete a specified project. Deleting a project removes all associated whiteboards from the project, setting them to have no project assignment. \n\n**[Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `whiteboard_project:write:admin`,`whiteboard_project:write`\n\n**[Granular Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `whiteboard:delete:project`,`whiteboard:delete:project:admin`\n\n**[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `LIGHT`","operationId":"Deleteproject","parameters":[{"name":"projectId","in":"path","description":"The project ID.","required":true,"schema":{"type":"string","example":"qiMWddmtRxqwSFrK22lJPg"}}],"responses":{"204":{"description":"The project has been successfully deleted. No content is returned in the response body."},"403":{"description":"**HTTP Status Code:** `403` <br>\n Forbidden  \n\n **Error Code:** `111804` <br>\n Permission is needed to access this project. <br>\n"},"404":{"description":"**HTTP Status Code:** `404` <br>\n Not Found  \n\n **Error Code:** `38007` <br>\n The projectId is not exist. <br>\n"},"429":{"description":"**HTTP Status Code:** `429` <br>\n Too Many Requests. For more information, see [rate limits](https://developers.zoom.us/docs/api/rate-limits/). \n\n "}},"security":[{"openapi_oauth":["whiteboard_project:write:admin","whiteboard_project:write","whiteboard:delete:project","whiteboard:delete:project:admin"],"openapi_authorization":[]}],"x-extensions":{"x-permissions":[],"x-macro-scopes":["whiteboard_project:write:admin","whiteboard_project:write"],"x-granular-scopes":["whiteboard:delete:project","whiteboard:delete:project:admin"]}},"patch":{"tags":["Project"],"summary":"Update project basic information","description":"This API endpoint allows you to update the basic information of a specific project.\n\n**[Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `whiteboard_project:write:admin`,`whiteboard_project:write`\n\n**[Granular Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `whiteboard:update:project:admin`,`whiteboard:update:project`\n\n**[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `LIGHT`","operationId":"Updateproject","parameters":[{"name":"projectId","in":"path","description":"The project ID.","required":true,"schema":{"type":"string","example":"qiMWddmtRxqwSFrK22lJPg"}}],"requestBody":{"content":{"application/json":{"schema":{"type":"object","properties":{"project_name":{"maxLength":50,"minLength":1,"type":"string","description":"The new project name.","example":"New Project Name"}}}}}},"responses":{"204":{"description":"The project's basic information has been successfully updated. No content is returned in the response body."},"400":{"description":"**HTTP Status Code:** `400` <br>\n Bad Request  \n\n **Error Code:** `38002` <br>\n The project name is invalid. <br>\n"},"403":{"description":"**HTTP Status Code:** `403` <br>\n Forbidden  \n\n **Error Code:** `111804` <br>\n Permission is needed to access this project. <br>\n"},"404":{"description":"**HTTP Status Code:** `404` <br>\n Not Found  \n\n **Error Code:** `38007` <br>\n The project ID does not exist. <br>\n"},"429":{"description":"**HTTP Status Code:** `429` <br>\n Too Many Requests. For more information, see [rate limits](https://developers.zoom.us/docs/api/rate-limits/). \n\n "}},"security":[{"openapi_oauth":["whiteboard_project:write:admin","whiteboard_project:write","whiteboard:update:project:admin","whiteboard:update:project"],"openapi_authorization":[]}],"x-extensions":{"x-permissions":["WhiteboardManagement:Edit"],"x-macro-scopes":["whiteboard_project:write:admin","whiteboard_project:write"],"x-granular-scopes":["whiteboard:update:project:admin","whiteboard:update:project"]}}},"/whiteboards/projects/{projectId}/collaborators":{"get":{"tags":["Project"],"summary":"Get collaborators of a project","description":"Returns a list of a project collaborators.\n\n**[Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `whiteboard_project_collaborator:read`,`whiteboard_project_collaborator:read:admin`\n\n**[Granular Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `whiteboard:read:project_collaborator`,`whiteboard:read:project_collaborator:admin`\n\n**[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `LIGHT`","operationId":"Getcollaboratorsofaproject","parameters":[{"name":"projectId","in":"path","description":"The ID of the project.","required":true,"schema":{"type":"string","example":"HY8-AC_HSou4SXY1S-OmOg"}}],"responses":{"200":{"description":"Get collaborators of a project.","content":{"application/json":{"schema":{"type":"array","items":{"required":["collaborator_id"],"type":"object","properties":{"collaborator_id":{"type":"string","description":"`not nullable` The collaborator's unique ID.","example":"x4g6hy789k0o878k"},"collaborator_name":{"type":"string","description":"The collaborator's display name.","example":"Jack"},"user_id":{"type":"string","description":"`nullable` User ID. This response only returns if the `collaborator_type` is `0`. If the `collaborator_type` is **not** `0`, this returns null value.","example":"wf3h7uo1dk0v53bl"},"avatar":{"type":"string","description":"The collaborator profile picture.0","example":"https://content.zoom.us/swerwerw.jpeg"},"role":{"type":"integer","description":"The collaborator role type. Enum:\n * `0` - OWNER \n * `1` - CO_OWNER \n * `2` - EDITOR \n * `3` - COMMENTER \n * `4` - VIEWER ","example":2,"enum":[0,1,2,3,4]},"collaborator_type":{"type":"integer","description":"The collaborator type. \nEnum: \n* `0` - SAME_ACCOUNT_USER \n* `1` - EXTERNAL_USER ","example":0,"enum":[0,1]},"email":{"type":"string","description":"`nullable` Email. This response only returns if the `collaborator_type` is `0`. If the `collaborator_type` is **not** `0`, this returns null value.","example":"user@example.com"}},"description":"A user who works jointly on a project."}}}}},"403":{"description":"**HTTP Status Code:** `403` <br>\n Forbidden  \n\n **Error Code:** `111804` <br>\n Permission is needed to access this project. <br>\n"},"404":{"description":"**HTTP Status Code:** `404` <br>\n Not Found  \n\n **Error Code:** `38007` <br>\n The projectId is not exist. <br>\n"},"429":{"description":"**HTTP Status Code:** `429` <br>\n Too Many Requests. For more information, see [rate limits](https://developers.zoom.us/docs/api/rate-limits/). \n\n "}},"security":[{"openapi_oauth":["whiteboard_project_collaborator:read","whiteboard_project_collaborator:read:admin","whiteboard:read:project_collaborator","whiteboard:read:project_collaborator:admin"],"openapi_authorization":[]}],"x-extensions":{"x-permissions":["WhiteboardManagement:Read"],"x-macro-scopes":["whiteboard_project_collaborator:read","whiteboard_project_collaborator:read:admin"],"x-granular-scopes":["whiteboard:read:project_collaborator","whiteboard:read:project_collaborator:admin"]}},"post":{"tags":["Project"],"summary":"Share a project to new users","description":"Add new collaborators to a specified project. Project owners or authorized users can invite team members or external users to collaborate on a project with specified roles and permissions.\n\n**[Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `whiteboard_project_collaborator:write`,`whiteboard_project_collaborator:write:admin`\n\n**[Granular Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `whiteboard:write:project_collaborator`,`whiteboard:write:project_collaborator:admin`\n\n**[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `LIGHT`","operationId":"Shareaprojecttonewusers","parameters":[{"name":"projectId","in":"path","description":"The project ID.","required":true,"schema":{"type":"string","example":"N6XZFDEQTkWSsMsmO_M1XQ"}}],"requestBody":{"content":{"application/json":{"schema":{"required":["collaborators"],"type":"object","properties":{"skip_notifications":{"type":"boolean","description":" **Default is false (notifications will be sent)**.\n If set to `true`, collaborators and owners will not receive direct messages or emails when the project is shared.","example":false},"invite_message":{"maxLength":280,"minLength":0,"type":"string","description":"A custom message to include with the project invitation.","example":"I'm glad to invite you to join this project."},"collaborators":{"maxItems":20,"minItems":1,"type":"array","description":"List of users to add as collaborators to the project.","items":{"type":"object","properties":{"email":{"type":"string","description":"**User Email Address**: The email address of the user you want to share the project with.","example":"user@example.com."},"role":{"type":"integer","description":"Collaborator role type. When assigning a new `OWNER` or `CO_OWNER`, the specified user must belong to the same account as the original `OWNER`. If a new owner is designated for a project, the original owner will automatically be demoted to `CO_OWNER`.\nRole Enum Values: \n* `0` - OWNER \n* `1` - CO_OWNER \n* `2` - EDITOR \n* `3` - COMMENTER \n* `4` - VIEWER ","example":1}},"description":"A user who works jointly on a whiteboard."}}}}}}},"responses":{"201":{"description":"The collaborators have been successfully added to the project.","content":{"application/json":{"schema":{"type":"array","items":{"title":"root","type":"object","properties":{"collaborator_id":{"type":"string","description":"`not nullable` The collaborator's unique ID.","example":"x4g6hy789k0o878k"},"collaborator_name":{"type":"string","description":"The collaborator's display name.","example":"Jack"},"user_id":{"type":"string","description":"`nullable` User ID. This response only returns if the `collaborator_type` is `0`. If the `collaborator_type` is **not** `0`, this returns null value.","example":"wf3h7uo1dk0v53bl"},"avatar":{"type":"string","description":"Collaborator profile picture.","example":"https://content.zoom.us/swerwerw.jpeg"},"role":{"type":"integer","description":"Collaborator role type. \nEnum: \n* `0` - OWNER \n* `1` - CO_OWNER \n* `2` - EDITOR \n* `3` - COMMENTER \n* `4` - VIEWER "},"collaborator_type":{"type":"integer","description":"Collaborator type. \nEnum: \n* `0` - SAME_ACCOUNT_USER \n* `1` - EXTERNAL_USER"}},"description":"Users who work jointly on a whiteboard."}}}}},"400":{"description":"**HTTP Status Code:** `400` <br>\n Bad Request  \n\n "},"403":{"description":"**HTTP Status Code:** `403` <br>\n Forbidden  \n\n "},"404":{"description":"**HTTP Status Code:** `404` <br>\n Not Found  \n\n "},"429":{"description":"**HTTP Status Code:** `429` <br>\n Too Many Requests. For more information, see [rate limits](https://developers.zoom.us/docs/api/rate-limits/). \n\n "}},"security":[{"openapi_oauth":["whiteboard_project_collaborator:write","whiteboard_project_collaborator:write:admin","whiteboard:write:project_collaborator","whiteboard:write:project_collaborator:admin"],"openapi_authorization":[]}],"x-extensions":{"x-permissions":["WhiteboardManagement:Read","WhiteboardManagement:Edit"],"x-macro-scopes":["whiteboard_project_collaborator:write","whiteboard_project_collaborator:write:admin"],"x-granular-scopes":["whiteboard:write:project_collaborator","whiteboard:write:project_collaborator:admin"]}},"patch":{"tags":["Project"],"summary":"Update project collaborators","description":"Updates the role of a collaborator in a project, which allows you to modify the permissions of an existing collaborator in a specific project. \nNote that when assigning a new `OWNER` or `CO_OWNER`, the specified user must belong to the same account as the original `OWNER`. The original owner will automatically be demoted to `CO_OWNER` if a new owner is designated.\n\n**[Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `whiteboard_project_collaborator:write`,`whiteboard_project_collaborator:write:admin`\n\n**[Granular Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `whiteboard:update:project_collaborator`,`whiteboard:update:project_collaborator:admin`\n\n**[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `LIGHT`","operationId":"Updateprojectcollaborators","parameters":[{"name":"projectId","in":"path","description":"The project ID.","required":true,"schema":{"type":"string","example":"N6XZFDEQTkWSsMsmO_M1XQ"}}],"requestBody":{"content":{"application/json":{"schema":{"required":["collaborators"],"type":"object","properties":{"collaborators":{"maxItems":20,"minItems":1,"type":"array","description":"An array of collaborator objects.","items":{"required":["collaborator_id","role"],"type":"object","properties":{"collaborator_id":{"type":"string","description":"The collaborator's unique ID `not nullable` .","example":"x4g6hy789k0o878k"},"role":{"type":"integer","description":"Collaborator role type.\nWhen assigning a new `OWNER` or `CO_OWNER`, the specified user must belong to the same account as the original `OWNER`. If a new owner is designated for a project, the original owner will automatically be demoted to `CO_OWNER`.\n\nRole Enum Values:\n\n0 - OWNER\n1 - CO_OWNER\n2 - EDITOR\n3 - COMMENTER\n4 - VIEWER","example":2,"default":2,"enum":[0,1,2,3,4]}}}}},"description":"Update collaborators permission of a whiteboard."}}}},"responses":{"204":{"description":"Project collaborators updated successfully."},"400":{"description":"**HTTP Status Code:** `400` <br>\n Bad Request  \n\n **Error Code:** `34002` <br>\n Invalid collaborator_id {collaboratorId}. <br>\n"},"403":{"description":"**HTTP Status Code:** `403` <br>\n Forbidden  \n\n **Error Code:** `111804` <br>\n Permission is needed to access this project. <br>\n**Error Code:** `34001` <br>\n You do not have permission to update the role of collaborator {collaboratorId}. <br>\n"},"404":{"description":"**HTTP Status Code:** `404` <br>\n Not Found  \n\n **Error Code:** `35004` <br>\n The project ID {projectID} is not exist. <br>\n"},"429":{"description":"**HTTP Status Code:** `429` <br>\n Too Many Requests. For more information, see [rate limits](https://developers.zoom.us/docs/api/rate-limits/). \n\n "}},"security":[{"openapi_oauth":["whiteboard_project_collaborator:write","whiteboard_project_collaborator:write:admin","whiteboard:update:project_collaborator","whiteboard:update:project_collaborator:admin"],"openapi_authorization":[]}],"x-extensions":{"x-permissions":["WhiteboardManagement:Edit"],"x-macro-scopes":["whiteboard_project_collaborator:write","whiteboard_project_collaborator:write:admin"],"x-granular-scopes":["whiteboard:update:project_collaborator","whiteboard:update:project_collaborator:admin"]}}},"/whiteboards/projects/{projectId}/collaborators/{collaboratorId}":{"delete":{"tags":["Project"],"summary":"Remove the collaborator from a project","description":"This API endpoint allows you to remove a specific collaborator from a designated project. It enables project managers or authorized users to revoke access or remove a user from a project, enhancing project management and access control capabilities.\n\n**[Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `whiteboard_project_collaborator:write`,`whiteboard_project_collaborator:write:admin`\n\n**[Granular Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `whiteboard:delete:project_collaborator:admin`,`whiteboard:delete:project_collaborator`\n\n**[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `LIGHT`","operationId":"Removethecollaboratorfromaproject","parameters":[{"name":"projectId","in":"path","description":"The project ID.","required":true,"schema":{"type":"string","example":"N6XZFDEQTkWSsMsmO_M1XQ"}},{"name":"collaboratorId","in":"path","description":"The collaborator ID.","required":true,"schema":{"type":"string","example":"x4g6hy789k0o878k"}}],"responses":{"204":{"description":"The collaborator has been successfully removed from the project. No content is returned in the response body."},"403":{"description":"**HTTP Status Code:** `403` <br>\n Forbidden  \n\n **Error Code:** `111804` <br>\n Permission is needed to access this project. <br>\n**Error Code:** `34001` <br>\n You do not have permission to remove the collaborator {collaboratorId} from the project. <br>\n"},"404":{"description":"**HTTP Status Code:** `404` <br>\n Not Found  \n\n **Error Code:** `38004` <br>\n The project ID {projectID} is not exist. <br>\n**Error Code:** `34005` <br>\n The collaborator ID {collaboratorId} is not exist. <br>\n"},"429":{"description":"**HTTP Status Code:** `429` <br>\n Too Many Requests. For more information, see [rate limits](https://developers.zoom.us/docs/api/rate-limits/). \n\n "}},"security":[{"openapi_oauth":["whiteboard_project_collaborator:write","whiteboard_project_collaborator:write:admin","whiteboard:delete:project_collaborator:admin","whiteboard:delete:project_collaborator"],"openapi_authorization":[]}],"x-extensions":{"x-permissions":["WhiteboardManagement:Edit"],"x-macro-scopes":["whiteboard_project_collaborator:write","whiteboard_project_collaborator:write:admin"],"x-granular-scopes":["whiteboard:delete:project_collaborator:admin","whiteboard:delete:project_collaborator"]}}},"/whiteboards/projects/{projectId}/subprojects":{"get":{"tags":["Project"],"summary":"List subprojects","description":"Retrieves a list of all subprojects under a parent project. Returns all direct subprojects without pagination.\n\n**Project Hierarchy Constraints**\n* Project hierarchy supports up to 20 levels of nesting\n* Each project node can contain a maximum of 1,000 direct subprojects\n\n**[Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `whiteboard_project:read`,`whiteboard_project:read:admin`\n\n**[Granular Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `whiteboard:read:subproject`,`whiteboard:read:subproject:admin`\n\n**[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `LIGHT`","operationId":"listSubProjects","parameters":[{"name":"projectId","in":"path","description":"The project ID of the parent project.","required":true,"schema":{"type":"string","example":"abc123def456"}},{"name":"sort_column","in":"query","description":"The column to sort by.","required":false,"schema":{"type":"string","example":"last_update_time","default":"last_update_time","enum":["last_update_time","create_time","name"]}},{"name":"sort_asc","in":"query","description":"Sort in ascending order (true) or descending order (false).","required":false,"schema":{"type":"boolean","example":false,"default":false}},{"name":"search_key","in":"query","description":"The search keyword to filter projects by name.","required":false,"schema":{"maxLength":500,"minLength":0,"type":"string","example":"Q1 Planning"}}],"responses":{"200":{"description":"List of subprojects retrieved successfully.","content":{"application/json":{"schema":{"type":"object","properties":{"projects":{"type":"array","description":"Array of subprojects.","items":{"required":["create_time","parent_project_id","project_id","project_link","project_name","starred","update_time"],"type":"object","properties":{"project_id":{"type":"string","description":"The Project ID","example":"qiMWddmtRxqwSFrK22lJPg"},"project_name":{"type":"string","description":"The name of the project.","example":"Q1 Planning"},"starred":{"type":"boolean","description":"Whether the project is starred by the current user.","example":false},"parent_project_id":{"type":"string","description":"The ID of the parent project.","example":"parent123abc"},"create_time":{"type":"string","description":"The date and time when the project was created, in ISO 8601 format (UTC/GMT).","format":"date-time","example":"2024-03-15T09:00:00Z"},"update_time":{"type":"string","description":"The date and time when the project was last updated, in ISO 8601 format (UTC/GMT).","format":"date-time","example":"2024-03-15T10:30:00Z"},"project_link":{"type":"string","description":"The project redirect link.","example":"https://zoom.us/wb#/project/i1Ts2cRpSASonwbvTiPlUQ"}}}}}}}}},"400":{"description":"**HTTP Status Code:** `400` <br>\n Bad Request  \n\n **Error Code:** `34002` <br>\n Invalid parameter {field_name}. <br>\n"},"403":{"description":"**HTTP Status Code:** `403` <br>\n Forbidden  \n\n **Error Code:** `111804` <br>\n Permission is needed to access this project. <br>\n"},"404":{"description":"**HTTP Status Code:** `404` <br>\n Not Found  \n\n **Error Code:** `34000` <br>\n The project does not exist. <br>\n"},"429":{"description":"**HTTP Status Code:** `429` <br>\n Too Many Requests. For more information, see [rate limits](https://developers.zoom.us/docs/api/rate-limits/). \n\n "}},"security":[{"openapi_oauth":["whiteboard_project:read","whiteboard_project:read:admin","whiteboard:read:subproject","whiteboard:read:subproject:admin"],"openapi_authorization":[]}],"x-extensions":{"x-permissions":["WhiteboardManagement:Read"],"x-macro-scopes":["whiteboard_project:read","whiteboard_project:read:admin"],"x-granular-scopes":["whiteboard:read:subproject","whiteboard:read:subproject:admin"]}},"post":{"tags":["Project"],"summary":"Create a subproject","description":"Creates a new subproject under the specified parent project.\n\n**Project Hierarchy Constraints**\n* Project hierarchy supports up to 20 levels of nesting\n* Each project node can contain a maximum of 1,000 direct subprojects\n\n**[Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `whiteboard_project:write:admin`,`whiteboard_project:write`\n\n**[Granular Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `whiteboard:write:subproject`,`whiteboard:write:subproject:admin`\n\n**[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `LIGHT`\n\n**Not supported in Gov cluster** ","operationId":"createSubProject","parameters":[{"name":"projectId","in":"path","description":"The project ID of the parent project.","required":true,"schema":{"type":"string","example":"abc123def456"}}],"requestBody":{"content":{"application/json":{"schema":{"required":["project_name"],"type":"object","properties":{"project_name":{"maxLength":255,"minLength":1,"type":"string","description":"The name of the subproject to create.","example":"Q1 Planning."}}}}}},"responses":{"201":{"description":"Subproject created successfully.","content":{"application/json":{"schema":{"required":["create_time","parent_project_id","project_id","project_name","starred","update_time"],"type":"object","properties":{"project_id":{"type":"string","description":"The Project ID","example":"qiMWddmtRxqwSFrK22lJPg"},"project_name":{"type":"string","description":"The name of the project.","example":"Q1 Planning"},"starred":{"type":"boolean","description":"Whether the project is starred by the current user.","example":false},"parent_project_id":{"type":"string","description":"The ID of the parent project.","example":"parent123abc"},"create_time":{"type":"string","description":"The date and time when the project was created, in ISO 8601 format (UTC/GMT).","format":"date-time","example":"2024-03-15T09:00:00Z"},"update_time":{"type":"string","description":"The date and time when the project was last updated, in ISO 8601 format (UTC/GMT).","format":"date-time","example":"2024-03-15T10:30:00Z"},"project_link":{"type":"string","description":"The project redirect link.","example":"https://zoom.us/wb#/project/i1Ts2cRpSASonwbvTiPlUQ"}}}}}},"400":{"description":"**HTTP Status Code:** `400` <br>\n Bad Request  \n\n **Error Code:** `34002` <br>\n Invalid prameter. <br>\n**Error Code:** `34003` <br>\n Maximum subproject depth of 20 levels exceeded. <br>\n**Error Code:** `34004` <br>\n Maximum subprojects limit of 1000 per node exceeded. <br>\n"},"403":{"description":"**HTTP Status Code:** `403` <br>\n Forbidden  \n\n **Error Code:** `111804` <br>\n Permission is needed to access this project. <br>\n"},"404":{"description":"**HTTP Status Code:** `404` <br>\n Not Found  \n\n **Error Code:** `34000` <br>\n The project is not exist. <br>\n"},"429":{"description":"**HTTP Status Code:** `429` <br>\n Too Many Requests. For more information, see [rate limits](https://developers.zoom.us/docs/api/rate-limits/). \n\n "}},"security":[{"openapi_oauth":["whiteboard_project:write:admin","whiteboard_project:write","whiteboard:write:subproject","whiteboard:write:subproject:admin"],"openapi_authorization":[]}],"x-extensions":{"x-permissions":["WhiteboardManagement:Edit"],"x-macro-scopes":["whiteboard_project:write:admin","whiteboard_project:write"],"x-granular-scopes":["whiteboard:write:subproject","whiteboard:write:subproject:admin"]}}},"/whiteboards/projects/{projectId}/whiteboards":{"post":{"tags":["Project"],"summary":"Move whiteboards to a project","description":"This API endpoint allows you to move one or more whiteboards to a specified project. It enables users to organize their whiteboards by associating them with a specific project, enhancing project management capabilities.\n\n**[Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `whiteboard_project:write:admin`,`whiteboard_project:write`\n\n**[Granular Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `whiteboard:write:project_whiteboard`,`whiteboard:write:project_whiteboard:admin`\n\n**[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `LIGHT`","operationId":"Movewhiteboardstoproject","parameters":[{"name":"projectId","in":"path","description":"The Project ID","required":true,"schema":{"type":"string","example":"qiMWddmtRxqwSFrK22lJPg"}}],"requestBody":{"content":{"application/json":{"schema":{"required":["whiteboard_ids"],"type":"object","properties":{"whiteboard_ids":{"title":"whiteboard_id","maxItems":50,"minItems":1,"type":"array","description":"The whiteboard ID list","items":{"type":"string","description":"The whiteboard ID.","example":"dZO3Wd9XT4mgXdNPbMm6tw"}}}}}}},"responses":{"201":{"description":"The whiteboards have been successfully moved to the project.","content":{"application/json":{"schema":{"type":"object","properties":{"whiteboard_ids":{"type":"array","description":"The whiteboard ID list","items":{"type":"string","description":"The whiteboard ID.","example":"dZO3Wd9XT4mgXdNPbMm6tw"}}}}}}},"403":{"description":"**HTTP Status Code:** `403` <br>\n Forbidden  \n\n **Error Code:** `111804` <br>\n Permission is needed to access this project. <br>\n**Error Code:** `34001` <br>\n You do not have permission to move {whiteboardID} to the project. <br>\n"},"404":{"description":"**HTTP Status Code:** `404` <br>\n Not Found  \n\n **Error Code:** `38007` <br>\n The projectId is not exist. <br>\n"},"429":{"description":"**HTTP Status Code:** `429` <br>\n Too Many Requests. For more information, see [rate limits](https://developers.zoom.us/docs/api/rate-limits/). \n\n "}},"security":[{"openapi_oauth":["whiteboard_project:write:admin","whiteboard_project:write","whiteboard:write:project_whiteboard","whiteboard:write:project_whiteboard:admin"],"openapi_authorization":[]}],"x-extensions":{"x-permissions":["WhiteboardManagement:Edit"],"x-macro-scopes":["whiteboard_project:write:admin","whiteboard_project:write"],"x-granular-scopes":["whiteboard:write:project_whiteboard","whiteboard:write:project_whiteboard:admin"]}},"delete":{"tags":["Project"],"summary":"Remove whiteboards from a project","description":"This API endpoint allows you to remove one or more whiteboards from a specified project. \n\n**[Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `whiteboard_project:write:admin`,`whiteboard_project:write`\n\n**[Granular Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `whiteboard:delete:project_whiteboard`,`whiteboard:delete:project_whiteboard:admin`\n\n**[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `LIGHT`","operationId":"Removewhiteboardsfromaproject","parameters":[{"name":"projectId","in":"path","description":"The project ID.","required":true,"schema":{"type":"string","example":"N6XZFDEQTkWSsMsmO_M1XQ"}}],"requestBody":{"content":{"application/json":{"schema":{"required":["whiteboard_ids"],"type":"object","properties":{"whiteboard_ids":{"maxItems":50,"minItems":1,"type":"array","description":"The whiteboard ID list.","items":{"type":"string","description":"The whiteboard ID.","example":"W6Uuv4qUSfuJlp_GXGi36A"}}}}}}},"responses":{"204":{"description":"The whiteboards have been successfully removed from the project. No content is returned in the response body."},"403":{"description":"**HTTP Status Code:** `403` <br>\n Forbidden  \n\n **Error Code:** `111804` <br>\n Permission is needed to access this project. <br>\n**Error Code:** `34001` <br>\n You have no permission to add {whiteboardID} to the project. <br>\n"},"404":{"description":"**HTTP Status Code:** `404` <br>\n Not Found  \n\n **Error Code:** `38007` <br>\n The project ID does not exist. <br>\n"},"429":{"description":"**HTTP Status Code:** `429` <br>\n Too Many Requests. For more information, see [rate limits](https://developers.zoom.us/docs/api/rate-limits/). \n\n "}},"security":[{"openapi_oauth":["whiteboard_project:write:admin","whiteboard_project:write","whiteboard:delete:project_whiteboard","whiteboard:delete:project_whiteboard:admin"],"openapi_authorization":[]}],"x-extensions":{"x-permissions":["WhiteboardManagement:Edit"],"x-macro-scopes":["whiteboard_project:write:admin","whiteboard_project:write"],"x-granular-scopes":["whiteboard:delete:project_whiteboard","whiteboard:delete:project_whiteboard:admin"]}}},"/whiteboards/{whiteboardId}/share_setting":{"patch":{"tags":["Settings"],"summary":"Update whiteboard share setting","description":"Updates the whiteboard share setting. \n\n\n\n**[Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `whiteboard_share_setting:write`,`whiteboard_share_setting:write:admin`\n\n**[Granular Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `whiteboard:update:share_setting:admin`,`whiteboard:update:share_setting`\n\n**[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `MEDIUM`","operationId":"UpdateAWhiteboardShareSetting","parameters":[{"name":"whiteboardId","in":"path","description":"The ID of the whiteboard.","required":true,"schema":{"type":"string","example":"HY8-AC_HSou4SXY1S-OmOg"}}],"requestBody":{"content":{"application/json":{"schema":{"type":"object","properties":{"share_link_setting":{"type":"object","properties":{"share_scope":{"type":"integer","description":"The access type of whiteboard share link. \n* Enum: \n* `0` - `Restricted`, Only people added can open with this link \n* `1` - `Same account` \n* `2` - Anyone \n* `3` - SAME_ACCOUNT_EXTERNAL_AUTH \n","example":0,"default":0,"enum":[0,1,2,3],"x-enum-descriptions":["Restricted. Only people added can open with this link.","Same account","Anyone","Same account external auth"]},"share_role":{"type":"integer","description":"The access level of a whiteboard share link. Use this field with `share_scope`. If `share_scope` set `0` - `Restricted`, this field is null. If `share_scope` set `1` - `Same account` or `2` - `Anyone`, this filed can be `2` - `Editor`, `3` - `Commenter` or `4` - `Viewer`. \n* Enum: \n* `2` - `Editor`\n* `3` - `Commenter` \n* `4` - Viewer \n","example":2,"enum":[2,3,4],"x-enum-descriptions":["Editor","Commenter","Viewer"]}},"description":"The access level and access type of a current whiteboard's share link."}},"description":"Updates a whiteboard's share setting."}}}},"responses":{"204":{"description":"**HTTP Status Code**: `204`   \n \nWhiteboard share setting updated successfully."},"400":{"description":"**HTTP Status Code:** `400` <br>\n Bad Request  \n\n **Error Code:** `34002` <br>\n Share role must be viewer for everyone. <br>\n**Error Code:** `34002` <br>\n Share role can't be null, owner, or co-owner for same account. <br>\n"},"403":{"description":"**HTTP Status Code:** `403` <br>\n Forbidden  \n\n **Error Code:** `111804` <br>\n Permission is needed to access this document. <br>\n"},"429":{"description":"**HTTP Status Code:** `429` <br>\n Too Many Requests. For more information, see [rate limits](https://developers.zoom.us/docs/api/rest/rate-limits/). \n\n "}},"security":[{"openapi_oauth":["whiteboard_share_setting:write","whiteboard_share_setting:write:admin","whiteboard:update:share_setting:admin","whiteboard:update:share_setting"],"openapi_authorization":[]}],"x-extensions":{"x-permissions":["WhiteboardManagement:Edit"],"x-macro-scopes":["whiteboard_share_setting:write","whiteboard_share_setting:write:admin"],"x-granular-scopes":["whiteboard:update:share_setting:admin","whiteboard:update:share_setting"]}}}},"components":{"securitySchemes":{"openapi_authorization":{"type":"apiKey","name":"Authorization","in":"header"},"openapi_oauth":{"type":"oauth2","flows":{"authorizationCode":{"authorizationUrl":"/","tokenUrl":"","refreshUrl":"","scopes":{"whiteboard_content:read":"whiteboard_content:read","whiteboard_content:read:admin":"whiteboard_content:read:admin","whiteboard:read:list_sessions":"whiteboard:read:list_sessions","whiteboard:read:list_sessions:admin":"whiteboard:read:list_sessions:admin","whiteboard:read:archived_file":"whiteboard:read:archived_file","whiteboard:read:archived_file:admin":"whiteboard:read:archived_file:admin","whiteboard:read:session":"whiteboard:read:session","whiteboard:read:session:admin":"whiteboard:read:session:admin","whiteboard_classification_labels:read:admin":"whiteboard_classification_labels:read:admin","whiteboard_classification_labels:read":"whiteboard_classification_labels:read","whiteboard:read:list_classification_labels:admin":"whiteboard:read:list_classification_labels:admin","whiteboard:read:list_classification_labels":"whiteboard:read:list_classification_labels","whiteboard_classification_labels:write:admin":"whiteboard_classification_labels:write:admin","whiteboard:write:classification_labels:admin":"whiteboard:write:classification_labels:admin","whiteboard:update:classification_labels:admin":"whiteboard:update:classification_labels:admin","whiteboard:delete:classification_labels:admin":"whiteboard:delete:classification_labels:admin","whiteboard:read:classification_labels:admin":"whiteboard:read:classification_labels:admin","whiteboard:write:admin":"whiteboard:write:admin","whiteboard:write":"whiteboard:write","whiteboard:update:whiteboard_classification":"whiteboard:update:whiteboard_classification","whiteboard:update:whiteboard_classification:admin":"whiteboard:update:whiteboard_classification:admin","whiteboard:delete:whiteboard_classification":"whiteboard:delete:whiteboard_classification","whiteboard:delete:whiteboard_classification:admin":"whiteboard:delete:whiteboard_classification:admin","whiteboard_collaborator:write:admin":"whiteboard_collaborator:write:admin","whiteboard_collaborator:write":"whiteboard_collaborator:write","whiteboard:update:collaborator:admin":"whiteboard:update:collaborator:admin","whiteboard:update:collaborator":"whiteboard:update:collaborator","whiteboard:write:collaborator:admin":"whiteboard:write:collaborator:admin","whiteboard:write:collaborator":"whiteboard:write:collaborator","whiteboard_collaborator:read:admin":"whiteboard_collaborator:read:admin","whiteboard_collaborator:read":"whiteboard_collaborator:read","whiteboard:read:list_collaborators:admin":"whiteboard:read:list_collaborators:admin","whiteboard:read:list_collaborators":"whiteboard:read:list_collaborators","whiteboard:delete:collaborator:admin":"whiteboard:delete:collaborator:admin","whiteboard:delete:collaborator":"whiteboard:delete:collaborator","whiteboard:read:content":"whiteboard:read:content","whiteboard_content:write":"whiteboard_content:write","whiteboard:write:content":"whiteboard:write:content","whiteboard:delete:content":"whiteboard:delete:content","whiteboard:write:whiteboard":"whiteboard:write:whiteboard","whiteboard:read:admin":"whiteboard:read:admin","whiteboard:read":"whiteboard:read","whiteboard:read:list_whiteboards:admin":"whiteboard:read:list_whiteboards:admin","whiteboard:read:list_whiteboards":"whiteboard:read:list_whiteboards","whiteboard:read:whiteboard:admin":"whiteboard:read:whiteboard:admin","whiteboard:read:whiteboard":"whiteboard:read:whiteboard","whiteboard:delete:whiteboard:admin":"whiteboard:delete:whiteboard:admin","whiteboard:delete:whiteboard":"whiteboard:delete:whiteboard","whiteboard:update:whiteboard:admin":"whiteboard:update:whiteboard:admin","whiteboard_export:write:admin":"whiteboard_export:write:admin","whiteboard_export:write":"whiteboard_export:write","whiteboard:write:export":"whiteboard:write:export","whiteboard:write:export:admin":"whiteboard:write:export:admin","whiteboard:read:export":"whiteboard:read:export","whiteboard:read:export:admin":"whiteboard:read:export:admin","whiteboard_file:write:admin":"whiteboard_file:write:admin","whiteboard_file:write":"whiteboard_file:write","whiteboard:write:file":"whiteboard:write:file","whiteboard:write:file:admin":"whiteboard:write:file:admin","whiteboard_file:read":"whiteboard_file:read","whiteboard_file:read:admin":"whiteboard_file:read:admin","whiteboard:read:file":"whiteboard:read:file","whiteboard:read:file:admin":"whiteboard:read:file:admin","whiteboard_import:write":"whiteboard_import:write","whiteboard_import:write:admin":"whiteboard_import:write:admin","whiteboard:write:import":"whiteboard:write:import","whiteboard:write:import:admin":"whiteboard:write:import:admin","whiteboard_import:read":"whiteboard_import:read","whiteboard_import:read:admin":"whiteboard_import:read:admin","whiteboard:read:import:admin":"whiteboard:read:import:admin","whiteboard:read:import":"whiteboard:read:import","whiteboard_project:write":"whiteboard_project:write","whiteboard_project:write:admin":"whiteboard_project:write:admin","whiteboard:write:project":"whiteboard:write:project","whiteboard:write:project:admin":"whiteboard:write:project:admin","whiteboard_project:read":"whiteboard_project:read","whiteboard_project:read:admin":"whiteboard_project:read:admin","whiteboard:read:list_projects:admin":"whiteboard:read:list_projects:admin","whiteboard:read:list_projects":"whiteboard:read:list_projects","whiteboard:update:project:admin":"whiteboard:update:project:admin","whiteboard:update:project":"whiteboard:update:project","whiteboard:delete:project":"whiteboard:delete:project","whiteboard:delete:project:admin":"whiteboard:delete:project:admin","whiteboard:read:project":"whiteboard:read:project","whiteboard:read:project:admin":"whiteboard:read:project:admin","whiteboard_project_collaborator:read":"whiteboard_project_collaborator:read","whiteboard_project_collaborator:read:admin":"whiteboard_project_collaborator:read:admin","whiteboard:read:project_collaborator":"whiteboard:read:project_collaborator","whiteboard:read:project_collaborator:admin":"whiteboard:read:project_collaborator:admin","whiteboard_project_collaborator:write":"whiteboard_project_collaborator:write","whiteboard_project_collaborator:write:admin":"whiteboard_project_collaborator:write:admin","whiteboard:update:project_collaborator":"whiteboard:update:project_collaborator","whiteboard:update:project_collaborator:admin":"whiteboard:update:project_collaborator:admin","whiteboard:write:project_collaborator":"whiteboard:write:project_collaborator","whiteboard:write:project_collaborator:admin":"whiteboard:write:project_collaborator:admin","whiteboard:delete:project_collaborator:admin":"whiteboard:delete:project_collaborator:admin","whiteboard:delete:project_collaborator":"whiteboard:delete:project_collaborator","whiteboard:write:subproject":"whiteboard:write:subproject","whiteboard:write:subproject:admin":"whiteboard:write:subproject:admin","whiteboard:read:subproject":"whiteboard:read:subproject","whiteboard:read:subproject:admin":"whiteboard:read:subproject:admin","whiteboard:write:project_whiteboard":"whiteboard:write:project_whiteboard","whiteboard:write:project_whiteboard:admin":"whiteboard:write:project_whiteboard:admin","whiteboard:delete:project_whiteboard":"whiteboard:delete:project_whiteboard","whiteboard:delete:project_whiteboard:admin":"whiteboard:delete:project_whiteboard:admin","whiteboard_share_setting:write":"whiteboard_share_setting:write","whiteboard_share_setting:write:admin":"whiteboard_share_setting:write:admin","whiteboard:update:share_setting:admin":"whiteboard:update:share_setting:admin","whiteboard:update:share_setting":"whiteboard:update:share_setting"}}}}}}}