{"openapi":"3.0.0","info":{"title":"Canvas API","description":"The Canvas API extends [Canvas](https://support.zoom.com/hc/en/article?id=zm_kb&sysparm_article=KB0076439&_ics=1785788807006&irclickid=~cjqh-ea505~120WYWXNVLCDIysqrvlc748067XYWLKBqnic942ZP&_gl=1*1qhaied*_gcl_au*NTExMTA1MTU0LjE3ODQ2NDMwMDg.*_ga*MTExMjY2NjcuMTc4NDY0MzAxMw..*_ga_L8TBF28DDX*czE3ODU3ODM2MTIkbzgkZzEkdDE3ODU3ODU4MzckajUyJGwwJGgw) capabilities, enabling developers to integrate document management and collaboration into their applications. The API is organized into these areas: Document management, Document content, Data tables, Document metadata and access.","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":{"/docs/archive_attachments":{"get":{"tags":["Archiving"],"summary":"Download archive attachments","description":"Batch retrieve download URLs for attachments in archived files.\n\n**[Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `docs_archiving:read:admin`\n\n**[Granular Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `docs:read:archive:admin`\n\n**[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `MEDIUM`\n\n**Not supported in Gov cluster** ","operationId":"BatchGetArchiveAttachmentDownloadUrl","parameters":[{"name":"attachment_ids","in":"query","description":"A comma-separated list of attachment IDs to retrieve download URLs for. \n\nMust contain between 1 and 20 IDs.","required":true,"schema":{"type":"string","example":"GAM2plItRTCNxb8EYIn28Q,QISQ2bgbSpmjiFFee4XExB"}}],"responses":{"200":{"description":"Returns a list of attachments with their download URLs or failure reasons.","content":{"application/json":{"schema":{"type":"object","properties":{"attachments":{"type":"array","description":"List of attachments with their download URLs or failure reasons.","items":{"required":["attachment_id"],"type":"object","properties":{"attachment_id":{"type":"string","description":"The attachment ID.","example":"QISQ2bgbSpmjiFFee4XExB"},"download_url":{"type":"string","description":"The signed download URL for the attachment, valid for 1 hour. \n\nEmpty if the download URL could not be retrieved.","example":"https://example.com/download/document.pdf"},"failed_reason":{"type":"string","description":"The reason for failure if the download URL could not be retrieved. \n\nEmpty if the download URL was successfully retrieved.","example":"The resource does not exist."}}}}}}}}},"400":{"description":"**HTTP Status Code:** `400` <br>\n Bad Request  Invalid parameters. \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_authorization":[]}],"x-extensions":{"x-permissions":["DocsContent:Read","NotesContent:Read","SmartMeetingSummaryMgt:Read"],"x-macro-scopes":["docs_archiving:read:admin"],"x-granular-scopes":["docs:read:archive:admin"]}}},"/docs/archives":{"get":{"tags":["Archiving"],"summary":"List doc archive data","description":"List archived documents for a given account within a specified time range. \n\nEach archive record includes a `download_url` for downloading the complete archived content as a **JSON** file. \n\nSee the `download_url` field description for the full JSON schema definition.\n\n**[Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `docs_archiving:read:admin`\n\n**[Granular Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `docs:read:archive:admin`\n\n**[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `MEDIUM`\n\n**Not supported in Gov cluster** ","operationId":"Listdocarchive","parameters":[{"name":"from","in":"query","description":"The start of the query time range in RFC 3339 format. \n\nOnly archive records with `archive_time` later than or equal to `from` will be returned.","required":true,"schema":{"type":"string","format":"date-time","example":"2026-02-13T00:00:00Z"}},{"name":"to","in":"query","description":"The end of the query time range in RFC 3339 format.\n\nOnly archive records with `archive_time` earlier than `to` will be returned. \n\nThe value must not be later than the current time; otherwise, a `400` error will be returned.","required":true,"schema":{"type":"string","format":"date-time","example":"2026-03-14T00:00:00Z"}},{"name":"page_size","in":"query","description":"The number of records returned per page in a single API call.","required":false,"schema":{"maximum":100,"type":"integer","format":"int32","example":20,"default":20}},{"name":"next_page_token","in":"query","description":"The next page token paginates through a large set of results. A next page token is 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":"IAfJX3jsOLW7w3dokmFl84zOa0MAVGyMEB2"}},{"name":"products","in":"query","description":"Specify the type of archived data to retrieve. \n\nAllowed values: \n- `docs` \n- `my_notes` \n- `meeting_summary`. \n\nTo specify multiple values, concatenate them with commas `,`.\n\nIf this field is omitted or the string is empty, the API returns archived data for all products that the current token has permission to access. For example, if the token only has `DocsContent:Read` permission, only Docs archived data will be returned.\n\nIf specific products are provided, the API returns only the specified types. However, the token must have the corresponding permission for each requested product; otherwise, a `403 Forbidden` error will be returned.\n\nIf the token has no archive-related permissions at all, a `403 Forbidden` error will be returned regardless of this field's value.","required":false,"schema":{"type":"string","example":"docs,my_notes,meeting_summary"}}],"responses":{"200":{"description":"The returned archived files list.","content":{"application/json":{"schema":{"required":["from","next_page_token","page_size","to","total_records"],"type":"object","properties":{"from":{"type":"string","description":"The queried start date.","format":"date-time","example":"2026-02-13T00:00:00Z"},"to":{"type":"string","description":"The queried end date.","format":"date-time","example":"2026-03-14T00:00:00Z"},"page_size":{"type":"integer","description":"The number of records returned per page in a single API call.","format":"int32","example":20},"next_page_token":{"type":"string","description":"The next page token paginates through a large set of results. A next page token is returned whenever the set of available results exceeds the current page size. The expiration period for this token is 15 minutes.","example":"IAfJX3jsOLW7w3dokmFl84zOa0MAVGyMEB2"},"total_records":{"type":"integer","description":"The total number of returned sessions records.","example":30},"data":{"type":"array","description":"List of archive detail records under this account.","items":{"required":["archive_time","download_url","file_id","product","trigger_type","version"],"type":"object","properties":{"file_id":{"type":"string","description":"Unique identifier of the archived file.","example":"hCSzn_k9SGGXTwjujsF73w"},"version":{"type":"integer","description":"Archive version number that increments starting from 1.","format":"uint32","example":1},"product":{"type":"string","description":"Product type of the archived document.","example":"docs","enum":["docs","my_notes","meeting_summary"]},"trigger_type":{"type":"string","description":"Type of event that triggered this archive.","example":"doc_edit","enum":["doc_create","doc_edit","doc_view","comment_change","transcript_change"]},"archive_time":{"type":"string","description":"The time when this archive was created, in RFC 3339 format.","format":"date-time","example":"2023-07-27T17:36:34Z"},"download_url":{"type":"string","description":"The download URL contains the complete archived content of this version and is valid for 1 hour. \n\nPlease access and download it within the validity period. \n\nThe downloaded content is a **JSON** object which contains the following structure:\n\n**Archive Download Content Schema**\n\nThe JSON schema definition for the content downloaded from the `download_url` returned in archive records.\n\nEach archive is a complete point-in-time snapshot of a Zoom document, including its Markdown content, comments, reactions, user information, file metadata, and attachment references. The file is served as `application/json` and the download URL is valid for 1 hour.\n\n## Top-Level Fields\n\n| Field | Type | Required | Description |\n|-------|------|----------|-------------|\n| `file_id` | string | Yes | Unique identifier of the archived document |\n| `version` | integer | Yes | Archive version number (monotonically increasing per file) |\n| `product` | string | Yes | Product type of the archived document. Values: `docs`, `my_notes`, `meeting_summary` |\n| `trigger_type` | string | Yes | Event that triggered this archive. Values: `doc_edit`, `doc_create`, `doc_view`, `comment_change`, `transcript_change` |\n| `is_manual_notes` | boolean | No | Whether the MyNotes content in this version was manually entered (vs. AI-enhanced). `false` indicates the content was processed with AI enhancement. Applicable only to the `my_notes` product |\n| `transcript` | object | No | Meeting transcript snapshot. Present only for `my_notes` product when transcript data is available. Structure defined in **Transcript** below |\n| `archive_time` | string | Yes | Document archived time in RFC 3339 format |\n| `file_metadata` | object | No | Document metadata snapshot at archive time. Structure defined in **FileMetadata** below |\n| `page_cover` | string | No | Page cover image URL |\n| `page_icon` | string | No | Page icon (emoji or URL) |\n| `operator` | object | No | User who triggered this archive event. Structure defined in **UserInfo** below |\n| `markdown` | string | Yes | Full document content exported as Markdown |\n| `threads` | array | No | Comment threads on the document. Each element follows the **Thread** structure below |\n| `page_reactions` | array | No | Page-level reactions (e.g., emoji reactions on the document). Each element follows the **PageReaction** structure below |\n| `users` | object | No | Map of `user_id` → user info for all users referenced in this archive. Each value follows the **UserInfo** structure below |\n| `attachments` | array | No | Document-level attachment metadata. Each element follows the **Attachment** structure below |\n\n## Nested Object Definitions\n\n### Transcript\n\nMeeting transcript snapshot for a MyNotes document. Contains the transcribed conversation items and the speaker roster.\n\n| Field | Type | Required | Description |\n|-------|------|----------|-------------|\n| `items` | array | No | Transcribed conversation items in chronological order. Each element follows the **TranscriptItem** structure below |\n| `speakers` | array | No | Speaker roster referenced by the transcript items. Each element follows the **TranscriptSpeaker** structure below |\n\n### TranscriptItem\n\nA single transcribed utterance within the transcript.\n\n| Field | Type | Required | Description |\n|-------|------|----------|-------------|\n| `text` | string | Yes | Transcribed text of this utterance |\n| `start_time` | string | Yes | Start time offset of this utterance within the meeting (e.g., `00:00:05`) |\n| `end_time` | string | Yes | End time offset of this utterance within the meeting (e.g., `00:00:09`) |\n| `user_id` | integer | No | Numeric speaker identifier, cross-referencing `user_id` in **TranscriptSpeaker** |\n| `highlight_flag` | integer | No | Whether this utterance is highlighted. `0` = normal, `1` = highlighted |\n\n### TranscriptSpeaker\n\nIdentity of a participant referenced by the transcript items.\n\n| Field | Type | Required | Description |\n|-------|------|----------|-------------|\n| `user_id` | integer | No | Numeric speaker identifier referenced by **TranscriptItem** `user_id` |\n| `zoom_user_id` | string | No | Zoom user identifier of the speaker |\n| `username` | string | No | Account username of the speaker |\n| `speaker_id` | string | No | Speaker identifier assigned within the meeting |\n| `speaker_name` | string | No | Display name of the speaker as shown in the transcript |\n| `speaker_zoom_user_id` | string | No | Zoom user identifier associated with the speaker entry |\n| `is_unknown` | boolean | No | Whether the speaker could not be identified |\n\n### FileMetadata\n\nSnapshot of document properties at the time of archiving.\n\n| Field | Type | Required | Description |\n|-------|------|----------|-------------|\n| `title` | string | Yes | Document title |\n| `owner_id` | string | Yes | User ID of the document owner |\n| `owner_name` | string | Yes | Display name of the document owner |\n| `owner_email` | string | No | Email address of the document owner |\n| `create_time` | string | Yes | Document creation time in RFC 3339 format |\n| `last_edit_time` | string | Yes | Last edit time in RFC 3339 format |\n| `is_deleted` | boolean | Yes | Whether the document was deleted at archive time |\n| `delete_time` | string | No | Deletion time in RFC 3339 format. Present only if `is_deleted` is true |\n\n### UserInfo\n\nUser identity information. Used in `operator` field and `users` map.\n\n| Field | Type | Required | Description |\n|-------|------|----------|-------------|\n| `user_id` | string | Yes | Unique user identifier |\n| `display_name` | string | Yes | User's display name |\n| `email` | string | No | User's email address |\n\n### Thread\n\nA comment thread attached to a specific location in the document.\n\n| Field | Type | Required | Description |\n|-------|------|----------|-------------|\n| `thread_id` | string | Yes | Unique thread identifier |\n| `root_block_id` | string | Yes | Block ID where the thread is anchored |\n| `block_ids` | array of string | No | Additional block IDs related to the thread |\n| `selected_content` | string | No | The selected text that the comment is attached to |\n| `comment_type_name` | string | Yes | Comment type. Accepted values: `block`, `page` ,`discussion`, `suggestion` |\n| `thread_status` | string | Yes | Thread status. Values: `open`, `resolved` |\n| `comment_count` | integer | Yes | Number of comments in this thread |\n| `created_by` | string | Yes | User ID who created the thread |\n| `updated_by` | string | No | User ID who last updated the thread |\n| `create_time` | string | Yes | Thread creation time in RFC 3339 format |\n| `modify_time` | string | Yes | Last modification time in RFC 3339 format |\n| `resolve_time` | string | No | Time when the thread was resolved in RFC 3339 format |\n| `latest_comment_create_time` | string | Yes | Creation time of the most recent comment in RFC 3339 format |\n| `comments` | array | No | List of comments in this thread. Each element follows the **Comment** structure below |\n| `is_deleted` | boolean | No | Whether the thread has been deleted |\n| `delete_time` | string | No | Deletion time in RFC 3339 format |\n\n### Comment\n\nAn individual comment within a thread.\n\n| Field | Type | Required | Description |\n|-------|------|----------|-------------|\n| `comment_id` | string | Yes | Unique comment identifier |\n| `thread_id` | string | Yes | Parent thread identifier |\n| `root_block_id` | string | Yes | Block ID where the comment is anchored |\n| `parent_id` | string | No | Parent comment ID (for nested replies) |\n| `content_plain_text` | string | Yes | Plain text content of the comment |\n| `attachments` | array | No | Attachments on this comment. Each element follows the **Attachment** structure below |\n| `created_by` | string | Yes | User ID who created the comment |\n| `updated_by` | string | No | User ID who last edited the comment |\n| `is_edited` | boolean | Yes | Whether the comment has been edited |\n| `create_time` | string | Yes | Comment creation time in RFC 3339 format |\n| `modify_time` | string | Yes | Last modification time in RFC 3339 format |\n| `reactions` | array | No | Reactions on this comment. Each element follows the **Reaction** structure below |\n| `is_deleted` | boolean | No | Whether the comment has been deleted |\n| `delete_time` | string | No | Deletion time in RFC 3339 format |\n\n### Reaction\n\nAn emoji reaction on a comment.\n\n| Field | Type | Required | Description |\n|-------|------|----------|-------------|\n| `reaction_id` | string | Yes | Unique reaction identifier |\n| `comment_id` | string | Yes | Comment this reaction belongs to |\n| `reaction` | string | Yes | Emoji value|\n| `created_by` | string | Yes | User ID who added the reaction |\n| `create_time` | string | Yes | Reaction creation time in RFC 3339 format |\n\n### PageReaction\n\nAn emoji reaction on the document itself.\n\n| Field | Type | Required | Description |\n|-------|------|----------|-------------|\n| `reaction_id` | string | Yes | Unique reaction identifier |\n| `reaction` | string | Yes | Emoji value|\n| `reaction_type` | integer | Yes | Reaction type. `1` = block-level reaction, `2` = page-level reaction |\n| `created_by` | string | Yes | User ID who added the reaction |\n| `create_time` | string | Yes | Reaction creation time in RFC 3339 format |\n\n### Attachment\n\nBasic metadata for a file attachment embedded in the document or comment. \n\nTo download the actual attachment file, use the `Download Archive Attachments` OpenAPI with the `attachment_id`.\n\n| Field | Type | Required | Description |\n|-------|------|----------|-------------|\n| `attachment_id` | string | Yes | Unique attachment identifier.  |\n| `name` | string | Yes | Attachment name |\n| `type` | string | Yes | MIME type (e.g., `image/png`, `application/pdf`) |\n| `size` | integer | Yes | File size in bytes |\n\n## JSON Example\n\n```json\n{\n  \"file_id\": \"zD83pVKRS2WrCBFHsfPMng\",\n  \"version\": 3,\n  \"product\": \"docs\",\n  \"trigger_type\": \"comment_change\",\n  \"archive_time\": \"2026-04-09T08:34:23Z\",\n  \"file_metadata\": {\n    \"title\": \"Q1 Project Plan\",\n    \"owner_id\": \"OnsTZFMpTUWD_YTo2Z_3Lg\",\n    \"owner_name\": \"Alice Johnson\",\n    \"owner_email\": \"alice.johnson@example.com\",\n    \"create_time\": \"2026-01-15T09:00:00Z\",\n    \"last_edit_time\": \"2026-04-09T08:30:00Z\",\n    \"is_deleted\": false\n  },\n  \"page_cover\": \"https://example.com/covers/q1-plan.png\",\n  \"page_icon\": \"📋\",\n  \"operator\": {\n    \"user_id\": \"KxR4mWVeQdGt7Lp1Nf_08w\",\n    \"display_name\": \"Bob Smith\",\n    \"email\": \"bob.smith@example.com\"\n  },\n  \"markdown\": \"# Q1 Project Plan\\n\\n## Goals\\n\\n- Launch feature A\\n- Complete migration B\\n\\n## Timeline\\n\\n| Phase | Date |\\n|-------|------|\\n| Design | Jan 15 |\\n| Dev | Feb 1 |\\n| QA | Feb 20 |\\n\",\n  \"threads\": [\n    {\n      \"thread_id\": \"a084b2c7874c42ce9fe5b976160a332d\",\n      \"root_block_id\": \"5a10e3c540dc4914ae7c846fa497f183\",\n      \"block_ids\": [\"5a10e3c540dc4914ae7c846fa497f183\"],\n      \"selected_content\": \"Launch feature A\",\n      \"comment_type_name\": \"block\",\n      \"thread_status\": \"open\",\n      \"comment_count\": 2,\n      \"created_by\": \"Hj2sNkLdS5qPwU8rY_v7Xg\",\n      \"create_time\": \"2026-04-01T10:00:00Z\",\n      \"modify_time\": \"2026-04-08T14:00:00Z\",\n      \"latest_comment_create_time\": \"2026-04-08T14:00:00Z\",\n      \"comments\": [\n        {\n          \"comment_id\": \"fcf7bf67fe134d20a49913c7d1e7ea4f\",\n          \"thread_id\": \"a084b2c7874c42ce9fe5b976160a332d\",\n          \"root_block_id\": \"5a10e3c540dc4914ae7c846fa497f183\",\n          \"content_plain_text\": \"Should we push this to Q2?\",\n          \"attachments\": [\n            {\n              \"attachmentId\": \"xUt5QFe-Sq6_8YPigKt3Eg\",\n              \"name\": \"image.png\",\n              \"type\": \"image/png\",\n              \"size\": \"171153\"\n            }\n          ],\n          \"created_by\": \"Hj2sNkLdS5qPwU8rY_v7Xg\",\n          \"is_edited\": false,\n          \"create_time\": \"2026-04-01T10:00:00Z\",\n          \"modify_time\": \"2026-04-01T10:00:00Z\",\n          \"reactions\": [\n            {\n              \"reaction_id\": \"b7e3f91a2c4d48e6a1d5c8f0e2b4a6d8\",\n              \"comment_id\": \"fcf7bf67fe134d20a49913c7d1e7ea4f\",\n              \"reaction\": \"👍\",\n              \"created_by\": \"OnsTZFMpTUWD_YTo2Z_3Lg\",\n              \"create_time\": \"2026-04-02T08:00:00Z\"\n            }\n          ]\n        },\n        {\n          \"comment_id\": \"d2a1c4e6f8b0374a9c5e7d1f3b6a8e0c\",\n          \"thread_id\": \"a084b2c7874c42ce9fe5b976160a332d\",\n          \"root_block_id\": \"5a10e3c540dc4914ae7c846fa497f183\",\n          \"parent_id\": \"fcf7bf67fe134d20a49913c7d1e7ea4f\",\n          \"content_plain_text\": \"No, let's keep the original timeline.\",\n          \"created_by\": \"OnsTZFMpTUWD_YTo2Z_3Lg\",\n          \"is_edited\": false,\n          \"create_time\": \"2026-04-08T14:00:00Z\",\n          \"modify_time\": \"2026-04-08T14:00:00Z\"\n        }\n      ]\n    }\n  ],\n  \"page_reactions\": [\n    {\n      \"reaction_id\": \"e4f6a8c0d2b4917365e7f1a3c5d8b0e2\",\n      \"reaction\": \"🎉\",\n      \"created_by\": \"KxR4mWVeQdGt7Lp1Nf_08w\",\n      \"create_time\": \"2026-04-05T12:00:00Z\"\n    }\n  ],\n  \"users\": {\n    \"OnsTZFMpTUWD_YTo2Z_3Lg\": {\n      \"user_id\": \"OnsTZFMpTUWD_YTo2Z_3Lg\",\n      \"display_name\": \"Alice Johnson\",\n      \"email\": \"alice.johnson@example.com\"\n    },\n    \"KxR4mWVeQdGt7Lp1Nf_08w\": {\n      \"user_id\": \"KxR4mWVeQdGt7Lp1Nf_08w\",\n      \"display_name\": \"Bob Smith\",\n      \"email\": \"bob.smith@example.com\"\n    },\n    \"Hj2sNkLdS5qPwU8rY_v7Xg\": {\n      \"user_id\": \"Hj2sNkLdS5qPwU8rY_v7Xg\",\n      \"display_name\": \"Charlie Brown\",\n      \"email\": \"charlie.brown@example.com\"\n    }\n  },\n  \"attachments\": [\n    {\n      \"attachment_id\": \"Tp7xKqW3RvNmYs9dF_c2Jw\",\n      \"name\": \"architecture-diagram.png\",\n      \"type\": \"image/png\",\n      \"size\": 245760\n    },\n    {\n      \"attachment_id\": \"Bm5nQeL8SxHkAr1gU_v4Zw\",\n      \"name\": \"requirements.pdf\",\n      \"type\": \"application/pdf\",\n      \"size\": 1048576\n    }\n  ]\n}\n```\n\n### JSON Example (MyNotes with Transcript)\n\nA `my_notes` archive triggered by a transcript change. It includes the `is_manual_notes` flag and the `transcript` object with conversation items and the speaker roster.\n\n```json\n{\n  \"file_id\": \"Nt4kPzQwRb6McD1sFgHy8A\",\n  \"version\": 5,\n  \"product\": \"my_notes\",\n  \"trigger_type\": \"transcript_change\",\n  \"is_manual_notes\": false,\n  \"archive_time\": \"2026-05-12T03:21:47Z\",\n  \"file_metadata\": {\n    \"title\": \"Weekly Sync - Engineering\",\n    \"owner_id\": \"OnsTZFMpTUWD_YTo2Z_3Lg\",\n    \"owner_name\": \"Alice Johnson\",\n    \"owner_email\": \"alice.johnson@example.com\",\n    \"create_time\": \"2026-05-12T02:00:00Z\",\n    \"last_edit_time\": \"2026-05-12T03:00:00Z\",\n    \"is_deleted\": false\n  },\n  \"page_icon\": \"🗒️\",\n  \"operator\": {\n    \"user_id\": \"OnsTZFMpTUWD_YTo2Z_3Lg\",\n    \"display_name\": \"Alice Johnson\",\n    \"email\": \"alice.johnson@example.com\"\n  },\n  \"markdown\": \"# Weekly Sync - Engineering\\n\\n## Summary\\n\\n- Reviewed sprint progress\\n- Agreed on release date\\n\",\n  \"transcript\": {\n    \"items\": [\n      {\n        \"text\": \"Good morning everyone, let's get started with the weekly sync.\",\n        \"start_time\": \"00:00:02\",\n        \"end_time\": \"00:00:06\",\n        \"user_id\": 101,\n        \"highlight_flag\": 0\n      },\n      {\n        \"text\": \"Sure. The payment service migration is on track for Friday.\",\n        \"start_time\": \"00:00:07\",\n        \"end_time\": \"00:00:11\",\n        \"user_id\": 102,\n        \"highlight_flag\": 1\n      },\n      {\n        \"text\": \"Great. Any blockers we should be aware of?\",\n        \"start_time\": \"00:00:12\",\n        \"end_time\": \"00:00:15\",\n        \"user_id\": 101,\n        \"highlight_flag\": 0\n      },\n      {\n        \"text\": \"Just waiting on the final QA sign-off, but we're confident.\",\n        \"start_time\": \"00:00:16\",\n        \"end_time\": \"00:00:20\",\n        \"user_id\": 103,\n        \"highlight_flag\": 0\n      },\n      {\n        \"text\": \"Perfect. Let's lock in Friday for the release then.\",\n        \"start_time\": \"00:00:21\",\n        \"end_time\": \"00:00:24\",\n        \"user_id\": 101,\n        \"highlight_flag\": 1\n      }\n    ],\n    \"speakers\": [\n      {\n        \"user_id\": 101,\n        \"zoom_user_id\": \"OnsTZFMpTUWD_YTo2Z_3Lg\",\n        \"username\": \"alice.johnson@example.com\",\n        \"speaker_id\": \"spk_001\",\n        \"speaker_name\": \"Alice Johnson\",\n        \"speaker_zoom_user_id\": \"OnsTZFMpTUWD_YTo2Z_3Lg\",\n        \"is_unknown\": false\n      },\n      {\n        \"user_id\": 102,\n        \"zoom_user_id\": \"KxR4mWVeQdGt7Lp1Nf_08w\",\n        \"username\": \"bob.smith@example.com\",\n        \"speaker_id\": \"spk_002\",\n        \"speaker_name\": \"Bob Smith\",\n        \"speaker_zoom_user_id\": \"KxR4mWVeQdGt7Lp1Nf_08w\",\n        \"is_unknown\": false\n      },\n      {\n        \"user_id\": 103,\n        \"zoom_user_id\": \"\",\n        \"username\": \"\",\n        \"speaker_id\": \"spk_003\",\n        \"speaker_name\": \"Guest Speaker\",\n        \"speaker_zoom_user_id\": \"\",\n        \"is_unknown\": true\n      }\n    ]\n  },\n  \"users\": {\n    \"OnsTZFMpTUWD_YTo2Z_3Lg\": {\n      \"user_id\": \"OnsTZFMpTUWD_YTo2Z_3Lg\",\n      \"display_name\": \"Alice Johnson\",\n      \"email\": \"alice.johnson@example.com\"\n    },\n    \"KxR4mWVeQdGt7Lp1Nf_08w\": {\n      \"user_id\": \"KxR4mWVeQdGt7Lp1Nf_08w\",\n      \"display_name\": \"Bob Smith\",\n      \"email\": \"bob.smith@example.com\"\n    }\n  }\n}\n```\n\n## Notes\n\n- All timestamp fields use **RFC 3339** string format (UTC).\n- The `users` map provides a lookup table for all `user_id` values referenced throughout the archive (in `operator`, `created_by`, `updated_by`, etc.).\n- The `markdown` field contains the complete document content at the time of archiving, exported in Markdown format.\n- The `attachments` at the top level are **document-level** attachments only. Comment-level attachments are nested within each comment's `attachments` field.\n- The `is_manual_notes` and `transcript` fields apply only to the `my_notes` product. For `docs` and `meeting_summary`, they are omitted.\n- `is_manual_notes` reflects how the MyNotes content in this version was produced: `true` means it was manually entered, while `false` means it was processed with AI enhancement.\n","example":"https://example.com/download/archive.json"}},"description":"Each item is an archived file."}}}}}}},"400":{"description":"**HTTP Status Code:** `400` <br>\n Bad Request. Invalid parameter. \n\n "},"403":{"description":"**HTTP Status Code:** `403` <br>\n Forbidden \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_authorization":[]}],"x-extensions":{"x-permissions":["DocsContent:Read","NotesContent:Read","SmartMeetingSummaryMgt:Read"],"x-macro-scopes":["docs_archiving:read:admin"],"x-granular-scopes":["docs:read:archive:admin"]}}},"/docs/files/{fileId}/collaborators":{"get":{"tags":["Collaborator"],"summary":"List collaborators of a file","description":"List collaborators of a file. Only `doc` or `data table` files are supported.\n\n**[Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `docs_collaborator:read`,`docs_collaborator:read:admin`\n\n**[Granular Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `docs:read:list_file_collaborators`,`docs:read:list_file_collaborators:admin`\n\n**[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `MEDIUM`","operationId":"ListCollaborators","parameters":[{"name":"fileId","in":"path","description":"The file ID in Docs.","required":true,"schema":{"type":"string","example":"_4oHCpleRgGumHa60amdKl"}}],"responses":{"200":{"description":"Returns the collaborators of a file.","content":{"application/json":{"schema":{"type":"object","properties":{"collaborators":{"maxItems":50,"minItems":0,"type":"array","description":"A list of collaborators. Each collaborator item must contain exactly one of the following fields: `user_id`, `channel_id`, or `email`.","items":{"required":["avatar_url","collaborator_id","collaborator_name","collaborator_type","role"],"type":"object","properties":{"collaborator_id":{"type":"string","description":"The collaborator item ID, used as the `collaboratorId` when removing or modifying a collaborator.","example":"user:9aSWJV2rTyWwkIDWmPYsfg"},"collaborator_type":{"type":"string","description":"The collaborator type.","example":"user","enum":["user","channel","email"]},"role":{"type":"string","description":"The collaborator role.","example":"viewer","enum":["viewer","commenter","editor","co-owner"]},"collaborator_name":{"type":"string","description":"The collaborator display name.","example":"Jack"},"user_id":{"type":"string","description":"The Zoom user ID. Available when `collaborator_type` = `user`.","example":"9aSWJV2rTyWwkIDWmPYsfg"},"channel_id":{"type":"string","description":"The Zoom Team Chat channel ID. Available when `collaborator_type` = `channel`.","example":"utSBcPSTQTmiebe_if1rpg"},"email":{"type":"string","description":"The email address. Available when `collaborator_type` = `email`.","example":"user@example.com"},"avatar_url":{"type":"string","description":"The avatar URL.","example":"https://images.zoom.us/p/v2/c6ea193b21e21r4rdqw21wdc3b0170737fb3213e21e34/1f1wwe2c3-432e-4dfa-92ab-f732w1a385q1301-2v21"}},"description":"The collaborator information."}}}}}}},"400":{"description":"**HTTP Status Code:** `400` <br>\n Bad Request  \n\n "},"403":{"description":"**HTTP Status Code:** `403` <br>\n Forbidden  Permission Denied. \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_authorization":[]}],"x-extensions":{"x-permissions":["DocsMgt:Read"],"x-macro-scopes":["docs_collaborator:read","docs_collaborator:read:admin"],"x-granular-scopes":["docs:read:list_file_collaborators","docs:read:list_file_collaborators:admin"]}},"post":{"tags":["Collaborator"],"summary":"Add collaborators for a file","description":"Share a file with newly added Zoom users or Zoom Team Chat channels. Only `doc` or `data table` files are supported.\n\n**[Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `docs_collaborator:write`,`docs_collaborator:write:admin`\n\n**[Granular Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `docs:write:collaborator`,`docs:write:collaborator:admin`\n\n**[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `MEDIUM`\n\n**Not supported in Gov cluster** ","operationId":"AddCollaborators","parameters":[{"name":"fileId","in":"path","description":"The ID of a file in Docs.","required":true,"schema":{"type":"string","example":"amgFY09ZSJOrgROOkWG77A"}}],"requestBody":{"content":{"application/json":{"schema":{"required":["collaborators"],"type":"object","properties":{"collaborators":{"maxItems":50,"minItems":1,"type":"array","description":"A list of collaborators to be added. Each collaborator item must contain exactly one of the following fields: `user_id`, `channel_id` and `email`.","items":{"required":["role"],"type":"object","properties":{"user_id":{"type":"string","description":"Zoom user ID.","example":"9aSWJV2rTyWwkIDWmPYsfg"},"channel_id":{"type":"string","description":"Zoom team chat channel ID.","example":"4b1826c3597b492e9b1f7a9bd59d3f8c"},"email":{"type":"string","description":"Email address.","example":"user@example.com"},"role":{"type":"string","description":"The collaborator role.","example":"viewer","enum":["viewer","commenter","editor","co-owner"]}}}}}}}}},"responses":{"201":{"description":"Returns the collaborators successfully added to collaborator list of this file.","content":{"application/json":{"schema":{"required":["collaborators"],"type":"object","properties":{"collaborators":{"type":"array","description":"Collaborators successfully added to collaborator list of this file. Each collaborator item must contain exactly one of the following fields: `user_id`, `channel_id`, or `email`.","items":{"required":["collaborator_id","collaborator_type","role"],"type":"object","properties":{"collaborator_id":{"type":"string","description":"The collaborator item ID, used as the `collaboratorId` when removing or modifying a collaborator.","example":"user:9aSWJV2rTyWwkIDWmPYsfg"},"collaborator_type":{"type":"string","description":"The collaborator type.","example":"user","enum":["user","channel","email"]},"role":{"type":"string","description":"The collaborator role.","example":"viewer","enum":["viewer","commenter","editor","co-owner"]},"user_id":{"type":"string","description":"The Zoom user ID. Available when `collaborator_type` = `user`.","example":"9aSWJV2rTyWwkIDWmPYsfg"},"channel_id":{"type":"string","description":"The Zoom Team Chat channel ID. Available when `collaborator_type` = `channel`.","example":"4b1826c3597b492e9b1f7a9bd59d3f8c"},"email":{"type":"string","description":"The email address. Available when `collaborator_type` = `email`.","example":"user@example.com"}}}}}}}}},"400":{"description":"**HTTP Status Code:** `400` <br>\n Bad Request  \n\n "},"403":{"description":"**HTTP Status Code:** `403` <br>\n Forbidden  Permission Denied. \n\n "},"404":{"description":"**HTTP Status Code:** `404` <br>\n Not Found  File 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_authorization":[]}],"x-extensions":{"x-permissions":["DocsMgt:Edit"],"x-macro-scopes":["docs_collaborator:write","docs_collaborator:write:admin"],"x-granular-scopes":["docs:write:collaborator","docs:write:collaborator:admin"]}}},"/docs/files/{fileId}/collaborators/{collaboratorId}":{"delete":{"tags":["Collaborator"],"summary":"Remove a collaborator from a file","description":"Remove a collaborator from a file. Only `doc` or `data table` files are supported.\n\n**[Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `docs_collaborator:delete`,`docs_collaborator:delete:admin`\n\n**[Granular Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `docs:delete:collaborator`,`docs:delete:collaborator:admin`\n\n**[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `MEDIUM`\n\n**Not supported in Gov cluster** ","operationId":"RemoveACollaborator","parameters":[{"name":"fileId","in":"path","description":"The ID of a file in Docs.","required":true,"schema":{"type":"string","example":"amgFY09ZSJOrgROOkWG77A"}},{"name":"collaboratorId","in":"path","description":"The ID of a collaborator item.","required":true,"schema":{"type":"string","example":"user:YFhmhCi0SZ-THaGh8dYqfw"}}],"responses":{"204":{"description":"Nothing to return."},"400":{"description":"**HTTP Status Code:** `400` <br>\n Bad Request  \n\n "},"403":{"description":"**HTTP Status Code:** `403` <br>\n Forbidden  Permission Denied. \n\n "},"404":{"description":"**HTTP Status Code:** `404` <br>\n Not Found  File 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_authorization":[]}],"x-extensions":{"x-permissions":["DocsMgt:Edit"],"x-macro-scopes":["docs_collaborator:delete","docs_collaborator:delete:admin"],"x-granular-scopes":["docs:delete:collaborator","docs:delete:collaborator:admin"]}},"patch":{"tags":["Collaborator"],"summary":"Modify a collaborator’s role on a file","description":"Modify a collaborator’s role on a file. Only `doc` or `data table` files are supported.\n\n**[Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `docs_collaborator:write`,`docs_collaborator:write:admin`\n\n**[Granular Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `docs:update:collaborator`,`docs:update:collaborator:admin`\n\n**[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `MEDIUM`\n\n**Not supported in Gov cluster** ","operationId":"ModifyCollaboratorRole","parameters":[{"name":"fileId","in":"path","description":"The ID of a file in Docs.","required":true,"schema":{"type":"string","example":"amgFY09ZSJOrgROOkWG77A"}},{"name":"collaboratorId","in":"path","description":"The ID of a collaborator item.","required":true,"schema":{"type":"string","example":"user:9aSWJV2rTyWwkIDWmPYsfg"}}],"requestBody":{"content":{"application/json":{"schema":{"required":["role"],"type":"object","properties":{"role":{"type":"string","description":"The collaborator role.","example":"viewer","enum":["viewer","commenter","editor","co-owner"]}}}}}},"responses":{"204":{"description":"Nothing to return."},"400":{"description":"**HTTP Status Code:** `400` <br>\n Bad Request  \n\n "},"403":{"description":"**HTTP Status Code:** `403` <br>\n Forbidden  Permission Denied. \n\n "},"404":{"description":"**HTTP Status Code:** `404` <br>\n Not Found  File 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_authorization":[]}],"x-extensions":{"x-permissions":["DocsMgt:Edit"],"x-macro-scopes":["docs_collaborator:write","docs_collaborator:write:admin"],"x-granular-scopes":["docs:update:collaborator","docs:update:collaborator:admin"]}}},"/docs/files/{fileId}/data_table":{"post":{"tags":["DataTable Content"],"summary":"Create data table","description":"Creates a new table inside an existing file. This API does not create a new `data table` file. To create a `data table` file, use the `Create a new file` endpoint with the `data_table` file type.\n\nThis API supports two host file types:\n- In a **doc** file, the inserted table is referred to as a **data table**.\n- In a **data table** file, the inserted table is referred to as a **table**.\n\n**[Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `canvas_data_table:write`\n\n**[Granular Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `canvas:write:data_table`\n\n**[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `MEDIUM`\n\n**Not supported in Gov cluster** ","operationId":"Createanembeddeddatatable","parameters":[{"name":"fileId","in":"path","description":"The file ID.","required":true,"schema":{"type":"string","example":"B6gebVLnRaOEVvVLfHlMSA"}}],"requestBody":{"content":{"application/json":{"schema":{"required":["columns","name"],"type":"object","properties":{"after_block_id":{"type":"string","description":"If `after_block_id` is provided, the new table is inserted after the specified block. If `after_block_id` is omitted, the new table is inserted at the end of the file.","example":"44879b1a2ee54ada9426b82c2e654c74"},"name":{"type":"string","description":"The table name.","example":"Project Tracker"},"columns":{"type":"array","description":"The list of columns to create.","items":{"required":["column_type","name"],"type":"object","properties":{"name":{"type":"string","description":"The column name.","example":"Text"},"column_type":{"type":"string","description":"The type of the column.","example":"text","enum":["text","number","percent","single_select","multiple_select","date","people","checkbox","attachment","reaction","created_by","updated_by","created_time","updated_time","currency","page","url"]},"description":{"type":"string","description":"Column Description","example":"Text Content"},"column_options":{"type":"object","properties":{"date_option":{"title":"date_option","required":["format","is_24_hour_format"],"type":"object","properties":{"format":{"type":"string","description":"The date display format. Examples are as follows:\n2025-10-21 12:00\n2025/10/21 12:00\n2025/10/21 00:00\n25-10-21 00:30\n10/21/2025 00:30\n10/21/25 00:30\n08/10/2025 01:00\n08/10/25 01:00","example":"MM/dd/yyyy","enum":["MM/dd/yyyy","MM/dd/yy","M/d/yyyy","yy-MM-dd","yyyy/MM/dd","yy/MM/dd","yyyy/M/d","yy/M/d","dd/MM/yyyy","dd/MM/yy","MMM d, yyyy","EEE, MMM d","EEE, MMM d, yyyy","EEE"]},"is_24_hour_format":{"type":"boolean","description":"If `true`, display in 24-hour format. If `false`, display in 12-hour format.","example":false}},"description":"The `date`|`created_time`|`updated_time` column option."},"number_option":{"title":"number_option","required":["decimal","show_separator"],"type":"object","properties":{"decimal":{"type":"integer","description":"The number of decimal places.","example":1,"enum":[0,1,2,3,4,5]},"show_separator":{"type":"boolean","description":"If `true`, display thousand separators. If `false`, do not display thousand separators.","example":false}},"description":"The `number` column option."},"select_option":{"title":"select_option","type":"object","properties":{"options":{"type":"array","description":"The option list.","items":{"type":"object","properties":{"name":{"type":"string","description":"The option name.","example":"Blue"}},"description":"A specific option."}}},"description":"The `single_select` and `multiple_select` column option."},"percent_option":{"title":"percent_option","required":["decimal","show_progress_bar"],"type":"object","properties":{"decimal":{"type":"integer","description":"The number of decimal places.","example":1,"enum":[0,1,2,3,4,5]},"show_progress_bar":{"type":"boolean","description":"If `true`, display the progress bar. If `false`, do not display the progress bar.","example":false}},"description":"The `percent` column option."},"people_option":{"title":"people_option","required":["is_multiple","is_notify"],"type":"object","properties":{"is_multiple":{"type":"boolean","description":"If `true`, allow selection of multiple people. If `false`, only one person can be selected.","example":false},"is_notify":{"type":"boolean","description":"If `true`, send a notification message after selecting someone. If `false`, do not send a notification message after selecting someone.","example":false}},"description":"The `people` column option."},"reaction_option":{"title":"reaction_option","required":["allow_commenter_react","display_type","icon"],"type":"object","properties":{"icon":{"required":["type","value"],"type":"object","properties":{"type":{"type":"string","description":"The icon display type. Currently only supports emoji.","example":"emoji","enum":["emoji"]},"value":{"type":"string","description":"The icon value.","example":"👍","enum":["👍","👎","🌟"]}},"description":"The icon content."},"display_type":{"type":"string","description":"The reaction icon display type.","example":"number","enum":["number","people","none"]},"allow_commenter_react":{"type":"boolean","description":"Whether a user with only commenter permission is allowed to click. If `true`, the user is allowed to click. If `false`, the user is not allowed to click.","example":false}},"description":"The `reaction` column option."},"currency_option":{"title":"currency_option","required":["decimal","format","symbol"],"type":"object","properties":{"decimal":{"type":"integer","description":"The number of decimal places.","example":1,"enum":[0,1,2,3,4,5]},"symbol":{"type":"string","description":"The currency symbol.","example":"$","enum":["$","¥","€","Ft","Rp","kr","R","CHF","DH","₹","zł","₽","₩","฿","₺","£"]},"format":{"type":"string","description":"The currency format.","example":"accounting","enum":["accounting","currency"]}},"description":"The `currency` column option."},"attachment_option":{"title":"attachment_option","required":["layout"],"type":"object","properties":{"layout":{"type":"string","description":"The attachment layout.","example":"thumbnail","enum":["thumbnail","full_width"]}},"description":"The `attachment` column option."},"url_option":{"title":"url_option","required":["display_type","open_type"],"type":"object","properties":{"display_type":{"type":"string","description":"The URL display type.","example":"title","enum":["title","full","icon"]},"open_type":{"type":"string","description":"The URL open type.","example":"current_page","enum":["current_page","new_page"]}},"description":"The `url` column option."}},"description":"The corresponding relationship between column type and column option is as follows:\n\n`date`|`created_time`|`updated_time`: date_option\n`number`: number_option\n`currency`: currency_option\n`percent`: percent_option\n`url`: url_option\n`attachment`: attachment_option\n`reaction`: reaction_option\n`single_select`|`multiple_select`: select_option\n`people`: people_option\n\nOther column types do not have a column option."}}}}}}}}},"responses":{"201":{"description":"Table created successfully.","content":{"application/json":{"schema":{"required":["columns","table_id"],"type":"object","properties":{"table_id":{"type":"string","description":"The ID of the created table.","example":"c9456fb41aac408286651625298e863c"},"name":{"type":"string","description":"The table name.","example":"Project Tracker"},"columns":{"type":"array","description":"The list of created columns.","items":{"required":["column_id","column_type","integrated","name"],"type":"object","properties":{"name":{"type":"string","description":"The column name.","example":"Text"},"column_type":{"type":"string","description":"The type of the column.","example":"text","enum":["text","number","percent","single_select","multiple_select","date","people","checkbox","attachment","reaction","created_by","updated_by","created_time","updated_time","currency","page","url"]},"description":{"type":"string","description":"Column Description","example":"Text Content"},"column_options":{"type":"object","properties":{"date_option":{"title":"date_option","required":["format","is_24_hour_format"],"type":"object","properties":{"format":{"type":"string","description":"The date format. Examples are as follows:\n2025-10-21 12:00\n2025/10/21 12:00\n2025/10/21 00:00\n25-10-21 00:30\n10/21/2025 00:30\n10/21/25 00:30\n08/10/2025 01:00\n08/10/25 01:00","example":"MM/dd/yyyy","enum":["MM/dd/yyyy","MM/dd/yy","M/d/yyyy","yy-MM-dd","yyyy/MM/dd","yy/MM/dd","yyyy/M/d","yy/M/d","dd/MM/yyyy","dd/MM/yy","MMM d, yyyy","EEE, MMM d","EEE, MMM d, yyyy","EEE"]},"is_24_hour_format":{"type":"boolean","description":"If `true`, display in 24-hour format. If `false`, display in 12-hour format.","example":false}},"description":"The `date`|`created_time`|`updated_time` column option."},"number_option":{"title":"number_option","required":["decimal","show_separator"],"type":"object","properties":{"decimal":{"type":"integer","description":"The number of decimal places.","example":1,"enum":[0,1,2,3,4,5]},"show_separator":{"type":"boolean","description":"If `true`, display thousand separators. If `false`, do not display thousand separators.","example":false}},"description":"The `number` column option."},"select_option":{"title":"select_option","type":"object","properties":{"options":{"type":"array","description":"The option list.","items":{"type":"object","properties":{"name":{"type":"string","description":"The option name.","example":"Blue"},"id":{"type":"string","description":"The option ID.","example":"A8xSJQDVf1dnVIVh"}},"description":"A specific option."}}},"description":"The `single_select` and `multiple_select` column option."},"percent_option":{"title":"percent_option","required":["decimal","show_progress_bar"],"type":"object","properties":{"decimal":{"type":"integer","description":"The number of decimal places.","example":1,"enum":[0,1,2,3,4,5]},"show_progress_bar":{"type":"boolean","description":"If `true`, display the progress bar. If `false`, do not display the progress bar.","example":false}},"description":"The `percent` column option."},"people_option":{"title":"people_option","required":["is_multiple","is_notify"],"type":"object","properties":{"is_multiple":{"type":"boolean","description":"If `true`, allow selection of multiple people. If `false`, only one person can be selected.","example":false},"is_notify":{"type":"boolean","description":"If `true`, send a notification message after selecting someone. If `false`, do not send a notification message after selecting someone.","example":false}},"description":"The `people` column option."},"reaction_option":{"title":"reaction_option","required":["allow_commenter_react","display_type","icon"],"type":"object","properties":{"icon":{"required":["type","value"],"type":"object","properties":{"type":{"type":"string","description":"The icon display type. Currently only supports emoji.","example":"emoji","enum":["emoji"]},"value":{"type":"string","description":"The icon value.","example":"👍","enum":["👍","👎","🌟"]}},"description":"The icon content."},"display_type":{"type":"string","description":"The reaction icon display type.","example":"number","enum":["number","people","none"]},"allow_commenter_react":{"type":"boolean","description":"Whether a user with only commenter permission is allowed to click. If `true`, the user is allowed to click. If `false`, the user is not allowed to click.","example":false}},"description":"The `reaction` column option."},"currency_option":{"title":"currency_option","required":["decimal","format","symbol"],"type":"object","properties":{"decimal":{"type":"integer","description":"The number of decimal places.","example":1,"enum":[0,1,2,3,4,5]},"symbol":{"type":"string","description":"The currency symbol.","example":"$","enum":["$","¥","€","Ft","Rp","kr","R","CHF","DH","₹","zł","₽","₩","฿","₺","£"]},"format":{"type":"string","description":"The currency format.","example":"accounting","enum":["accounting","currency"]}},"description":"The `currency` column option."},"attachment_option":{"title":"attachment_option","required":["layout"],"type":"object","properties":{"layout":{"type":"string","description":"The attachment layout.","example":"thumbnail","enum":["thumbnail","full_width"]}},"description":"The `attachment` column option."},"url_option":{"title":"url_option","required":["display_type","open_type"],"type":"object","properties":{"display_type":{"type":"string","description":"The URL display type.","example":"title","enum":["title","full","icon"]},"open_type":{"type":"string","description":"The URL open type.","example":"current_page","enum":["current_page","new_page"]}},"description":"The `url` column option."}},"description":"The corresponding relationship between column type and column option is as follows:\n\n`date`|`created_time`|`updated_time`: date_option\n`number`: number_option\n`currency`: currency_option\n`percent`: percent_option\n`url`: url_option\n`attachment`: attachment_option\n`reaction`: reaction_option\n`single_select`|`multiple_select`: select_option\n`people`: people_option\n\nOther column types do not have a column option."},"column_id":{"type":"string","description":"The column ID.","example":"dd08972e3bca46b89ba7bf0c9ee32ff5"},"integrated":{"type":"boolean","description":"If `true`, this column is an integrated column and cannot be edited by the user. If `false`, the user can edit it.","example":false}}}}}}}}},"400":{"description":"**HTTP Status Code:** `400` <br>\n Bad Request  Invalid parameters. \n\n **Error Code:** `2012` <br>\n Unsupported column type. <br>\n"},"403":{"description":"**HTTP Status Code:** `403` <br>\n Forbidden  No permission. \n\n **Error Code:** `2009` <br>\n No permission to access or modify this resource. <br>\n"},"404":{"description":"**HTTP Status Code:** `404` <br>\n Not Found  File not found. \n\n **Error Code:** `2000` <br>\n Block 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_authorization":[]}],"x-extensions":{"x-permissions":[],"x-macro-scopes":["canvas_data_table:write"],"x-granular-scopes":["canvas:write:data_table"]}}},"/docs/files/{fileId}/data_tables":{"get":{"tags":["DataTable Content"],"summary":"List data tables in a file","description":"Returns a list of data tables.\nThere are two scenarios when listing data tables of the specified file:\n1. If the file type is `doc`, this API returns all the inline data tables in the file.\n2. If the file type is `data_table`, this API returns all the tables.\n\n**[Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `canvas_data_table:read`\n\n**[Granular Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `canvas:read:data_table`\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":"Listdatatablesinfile","parameters":[{"name":"fileId","in":"path","description":"The file ID.","required":true,"schema":{"type":"string","example":"ADuV705lSXW4c6fBgQFarQ"}}],"responses":{"200":{"description":"**HTTP Status Code:** `200`  Data table list returned.","content":{"application/json":{"schema":{"required":["data_tables"],"type":"object","properties":{"data_tables":{"type":"array","description":"The data table list.","items":{"required":["data_table_id","is_synced","name"],"type":"object","properties":{"data_table_id":{"type":"string","description":"The data table ID.","example":"6108696fe9b44dc3a2675a448ab0c338"},"name":{"type":"string","description":"The table name.","example":"Project tracker"},"is_synced":{"type":"boolean","description":"Whether the table is synchronized. If `true`, the table is synchronized. If `false`, the table is the source table.","example":false},"related_table":{"required":["data_table_id","file_id"],"type":"object","properties":{"file_id":{"type":"string","description":"The related file ID.","example":"Fk0XWCWSTJqgTDcxbAKLfQ"},"data_table_id":{"type":"string","description":"The related data table ID.","example":"c7628bc10b5a458cb7b4af3747cbf32d"}},"description":"If `is_synced` is `true`, `related_table` contains the metadata of the related table."},"integration":{"required":["integration_type"],"type":"object","properties":{"marketplace_app_id":{"type":"string","description":"If the data source originates from an app integrated via the marketplace, a `marketplace_app_id` is provided. If it does not originate from the marketplace, there is no `marketplace_app_id`.","example":"wc9NSSgESB-qLJed0RSZjQ"},"integration_type":{"type":"string","description":"The data integration type, such as `jira` and `meeting`.","example":"jira"}},"description":"If `integration` is not empty, the data in this table originates from external sources. This table has certain limitations:\n1. Integrated columns cannot be edited, whereas user-created columns are editable.\n2. Editing of rows is not permitted."}}}}}}}}},"400":{"description":"**HTTP Status Code:** `400` <br>\n Bad Request  Invalid parameters. \n\n "},"403":{"description":"**HTTP Status Code:** `403` <br>\n Forbidden  Permission denied. \n\n **Error Code:** `2009` <br>\n No permission to access or modify this resource. <br>\n"},"404":{"description":"**HTTP Status Code:** `404` <br>\n Not Found  File 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_authorization":[]}],"x-extensions":{"x-permissions":[],"x-macro-scopes":["canvas_data_table:read"],"x-granular-scopes":["canvas:read:data_table"]}}},"/docs/files/{fileId}/data_tables/{tableId}":{"patch":{"tags":["DataTable Content"],"summary":"Update table metadata","description":"Update the table metadata, such as the title.\n\n**[Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `canvas_data_table:update`\n\n**[Granular Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `canvas:update:data_table`\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":"Updateembeddeddatatablename","parameters":[{"name":"fileId","in":"path","description":"The file ID.","required":true,"schema":{"type":"string","example":"N0n5PtdJSZq3_gZQT4L0JA"}},{"name":"tableId","in":"path","description":"The table ID.","required":true,"schema":{"type":"string","example":"2c3761cd5da242a59600180683e1ad8d"}}],"requestBody":{"content":{"application/json":{"schema":{"required":["title"],"type":"object","properties":{"title":{"type":"string","description":"The table title.","example":"Project Tracker"}}}}}},"responses":{"204":{"description":"Metadata updated successfully."},"400":{"description":"**HTTP Status Code:** `400` <br>\n Bad Request  Invalid parameters. \n\n "},"403":{"description":"**HTTP Status Code:** `403` <br>\n Forbidden  No permission. \n\n **Error Code:** `2009` <br>\n No permission to access or modify this resource. <br>\n"},"404":{"description":"**HTTP Status Code:** `404` <br>\n Not Found  File or data table not found. \n\n **Error Code:** `2000` <br>\n Table 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_authorization":[]}],"x-extensions":{"x-permissions":[],"x-macro-scopes":["canvas_data_table:update"],"x-granular-scopes":["canvas:update:data_table"]}}},"/docs/files/{fileId}/data_tables/{tableId}/columns":{"get":{"tags":["DataTable Content"],"summary":"List columns","description":"List the columns of a table.\n\n**[Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `canvas_data_table:read`\n\n**[Granular Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `canvas:read:data_table`\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":"Listdatatablecolumns","parameters":[{"name":"fileId","in":"path","description":"The file ID.","required":true,"schema":{"type":"string","example":"ADuV705lSXW4c6fBgQFarQ"}},{"name":"tableId","in":"path","description":"The table ID.","required":true,"schema":{"type":"string","example":"5bba6e51db0e41b88120be86732faf27"}}],"responses":{"200":{"description":"Column list of the table.","content":{"application/json":{"schema":{"required":["columns"],"type":"object","properties":{"columns":{"type":"array","description":"List of columns.","items":{"required":["column_id","column_type","integrated","name"],"type":"object","properties":{"name":{"type":"string","description":"The column name.","example":"Text"},"column_type":{"type":"string","description":"The type of the column.","example":"text","enum":["text","number","percent","single_select","multiple_select","date","people","checkbox","attachment","reaction","created_by","updated_by","created_time","updated_time","currency","page","url"]},"description":{"type":"string","description":"Column Description","example":"Text Content"},"column_options":{"type":"object","properties":{"date_option":{"title":"date_option","required":["format","is_24_hour_format"],"type":"object","properties":{"format":{"type":"string","description":"Date display format. Examples are provided below:\n2025-10-21 12:00\n2025/10/21 12:00\n2025/10/21 00:00\n25-10-21 00:30\n10/21/2025 00:30\n10/21/25 00:30\n08/10/2025 01:00\n08/10/25 01:00","example":"MM/dd/yyyy","enum":["MM/dd/yyyy","MM/dd/yy","M/d/yyyy","yy-MM-dd","yyyy/MM/dd","yy/MM/dd","yyyy/M/d","yy/M/d","dd/MM/yyyy","dd/MM/yy","MMM d, yyyy","EEE, MMM d","EEE, MMM d, yyyy","EEE"]},"is_24_hour_format":{"type":"boolean","description":"If `true`, display in 24-hour format. If `false`, display in 12-hour format.","example":false}},"description":"`date`|`created_time`|`updated_time` column option."},"number_option":{"title":"number_option","required":["decimal","show_separator"],"type":"object","properties":{"decimal":{"type":"integer","description":"The number of decimal places.","example":1,"enum":[0,1,2,3,4,5]},"show_separator":{"type":"boolean","description":"If `true`, display thousand separators. If `false`, do not display thousand separators.","example":false}},"description":"`number` column option."},"select_option":{"title":"select_option","required":["options"],"type":"object","properties":{"options":{"type":"array","description":"The option list.","items":{"type":"object","properties":{"option_name":{"type":"string","description":"The option name.","example":"Blue"},"option_id":{"type":"string","description":"The option ID.","example":"A8xSJQDVf1dnVIVh"}},"description":"A specific option."}}},"description":"`single_select` and `multiple_select` column option."},"percent_option":{"title":"percent_option","required":["decimal","show_progress_bar"],"type":"object","properties":{"decimal":{"type":"integer","description":"The number of decimal places.","example":1,"enum":[0,1,2,3,4,5]},"show_progress_bar":{"type":"boolean","description":"If `true`, display the progress bar. If `false`, do not display the progress bar.","example":false}},"description":"`percent` column option."},"people_option":{"title":"people_option","required":["is_multiple","is_notify"],"type":"object","properties":{"is_multiple":{"type":"boolean","description":"If `true`, allow selection of multiple people. If `false`, only one person can be selected.","example":false},"is_notify":{"type":"boolean","description":"If `true`, send a notification message after selecting someone. If `false`, do not send a notification message after selecting someone.","example":false}},"description":"`people` column option."},"reaction_option":{"title":"reaction_option","required":["allow_commenter_react","display_type","icon"],"type":"object","properties":{"icon":{"required":["type","value"],"type":"object","properties":{"type":{"type":"string","description":"The icon display type. Currently only supports `emoji`.","example":"emoji","enum":["emoji"]},"value":{"type":"string","description":"The icon value.","example":"👍","enum":["👍","👎","🌟"]}},"description":"The icon content."},"display_type":{"type":"string","description":"The reaction icon display type.","example":"number","enum":["number","people","none"]},"allow_commenter_react":{"type":"boolean","description":"If `true`, users with only commenter permission are allowed to react. If `false`, users with only commenter permission are not allowed to react.","example":false}},"description":"`reaction` column option."},"currency_option":{"title":"currency_option","required":["decimal","format","symbol"],"type":"object","properties":{"decimal":{"type":"integer","description":"The number of decimal places.","example":1,"enum":[0,1,2,3,4,5]},"symbol":{"type":"string","description":"The currency symbol.","example":"$","enum":["$","¥","€","Ft","Rp","kr","R","CHF","DH","₹","zł","₽","₩","฿","₺","£"]},"format":{"type":"string","description":"The currency format.","example":"accounting","enum":["accounting","currency"]}},"description":"`currency` column option."},"attachment_option":{"title":"attachment_option","required":["layout"],"type":"object","properties":{"layout":{"type":"string","description":"The attachment layout.","example":"thumbnail","enum":["thumbnail","full_width"]}},"description":"`attachment` column option."},"url_option":{"title":"url_option","required":["display_type","open_type"],"type":"object","properties":{"display_type":{"type":"string","description":"The URL display type.","example":"title","enum":["title","full","icon"]},"open_type":{"type":"string","description":"The URL open type.","example":"current_page","enum":["current_page","new_page"]}},"description":"`url` column option."}},"description":"The corresponding relationship between column type and column option is as follows:\n\n`date`|`created_time`|`updated_time`: date_option\n`number`: number_option\n`currency`: currency_option\n`percent`: percent_option\n`url`: url_option\n`attachment`: attachment_option\n`reaction`: reaction_option\n`single_select`|`multiple_select`: select_option\n`people`: people_option\n\nOther column types do not have column options."},"column_id":{"type":"string","description":"The column ID.","example":"dd08972e3bca46b89ba7bf0c9ee32ff5"},"integrated":{"type":"boolean","description":"If `true`, this column is an integrated column and cannot be edited by the user. If `false`, the user can edit it.","example":false}}}}}}}}},"400":{"description":"**HTTP Status Code:** `400` <br>\n Bad Request  Invalid parameters. \n\n "},"403":{"description":"**HTTP Status Code:** `403` <br>\n Forbidden  Permission denied. \n\n **Error Code:** `2009` <br>\n No permission to access or modify this resource. <br>\n"},"404":{"description":"**HTTP Status Code:** `404` <br>\n Not Found  File or table not found. \n\n **Error Code:** `2000` <br>\n Block 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_authorization":[]}],"x-extensions":{"x-permissions":[],"x-macro-scopes":["canvas_data_table:read"],"x-granular-scopes":["canvas:read:data_table"]}},"post":{"tags":["DataTable Content"],"summary":"Create a  column","description":"Add a new column to the table. A table allows up to 200 columns.\n\n**[Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `canvas_data_table:write`\n\n**[Granular Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `canvas:write:data_table`\n\n**[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `MEDIUM`\n\n**Not supported in Gov cluster** ","operationId":"Createacolumn","parameters":[{"name":"fileId","in":"path","description":"The ID of the file.","required":true,"schema":{"type":"string","example":"ADuV705lSXW4c6fBgQFarQ"}},{"name":"tableId","in":"path","description":"The ID of the table.","required":true,"schema":{"type":"string","example":"68cdb0c4a3ea494dbcf752e7b1ef12f3"}}],"requestBody":{"content":{"application/json":{"schema":{"required":["column_type","name"],"type":"object","properties":{"name":{"type":"string","description":"The name of the column. Must be unique within the same table.","example":"column name"},"description":{"type":"string","description":"Column description","example":"column description"},"column_type":{"type":"string","description":"The type of the column.","example":"text","enum":["text","number","percent","single_select","multiple_select","date","people","checkbox","attachment","reaction","created_by","updated_by","created_time","updated_time","currency","page","url"]},"column_options":{"type":"object","properties":{"date_option":{"title":"date_option","required":["format","is_24_hour_format"],"type":"object","properties":{"format":{"type":"string","description":"The date display format. Examples are as follows:\n2025-10-21 12:00\n2025/10/21 12:00\n2025/10/21 00:00\n25-10-21 00:30\n10/21/2025 00:30\n10/21/25 00:30\n08/10/2025 01:00\n08/10/25 01:00","example":"MM/dd/yyyy","enum":["MM/dd/yyyy","MM/dd/yy","M/d/yyyy","yy-MM-dd","yyyy/MM/dd","yy/MM/dd","yyyy/M/d","yy/M/d","dd/MM/yyyy","dd/MM/yy","MMM d, yyyy","EEE, MMM d","EEE, MMM d, yyyy","EEE"]},"is_24_hour_format":{"type":"boolean","description":"If `true`, display in 24-hour format. If `false`, display in 12-hour format.","example":false}},"description":"The `date`|`created_time`|`updated_time` column option."},"number_option":{"title":"number_option","required":["decimal","show_separator"],"type":"object","properties":{"decimal":{"type":"integer","description":"The number of decimal places.","example":1,"enum":[0,1,2,3,4,5]},"show_separator":{"type":"boolean","description":"If `true`, display thousand separators. If `false`, do not display thousand separators.","example":false}},"description":"The `number` column option."},"select_option":{"title":"select_option","type":"object","properties":{"options":{"type":"array","description":"The option list.","items":{"type":"object","properties":{"name":{"type":"string","description":"The option name.","example":"Blue"}},"description":"A specific option."}}},"description":"The `single_select` and `multiple_select` column option."},"percent_option":{"title":"percent_option","required":["decimal","show_progress_bar"],"type":"object","properties":{"decimal":{"type":"integer","description":"The number of decimal places.","example":1,"enum":[0,1,2,3,4,5]},"show_progress_bar":{"type":"boolean","description":"If `true`, display the progress bar. If `false`, do not display the progress bar.","example":false}},"description":"The `percent` column option."},"people_option":{"title":"people_option","required":["is_multiple","is_notify"],"type":"object","properties":{"is_multiple":{"type":"boolean","description":"If `true`, allow selection of multiple people. If `false`, only one person can be selected.","example":false},"is_notify":{"type":"boolean","description":"If `true`, send a notification message after selecting someone. If `false`, do not send a notification message after selecting someone.","example":false}},"description":"The `people` column option."},"reaction_option":{"title":"reaction_option","required":["allow_commenter_react","display_type","icon"],"type":"object","properties":{"icon":{"required":["type","value"],"type":"object","properties":{"type":{"type":"string","description":"The icon display type. Currently only supports emoji.","example":"emoji","enum":["emoji"]},"value":{"type":"string","description":"The icon value.","example":"👍","enum":["👍","👎","🌟"]}},"description":"The icon content."},"display_type":{"type":"string","description":"The reaction icon display type.","example":"number","enum":["number","people","none"]},"allow_commenter_react":{"type":"boolean","description":"Whether a user with only commenter permission is allowed to click. If `true`, the user is allowed to click. If `false`, the user is not allowed to click.","example":false}},"description":"The `reaction` column option."},"currency_option":{"title":"currency_option","required":["decimal","format","symbol"],"type":"object","properties":{"decimal":{"type":"integer","description":"The number of decimal places.","example":1,"enum":[0,1,2,3,4,5]},"symbol":{"type":"string","description":"The currency symbol.","example":"$","enum":["$","¥","€","Ft","Rp","kr","R","CHF","DH","₹","zł","₽","₩","฿","₺","£"]},"format":{"type":"string","description":"The currency format.","example":"accounting","enum":["accounting","currency"]}},"description":"The `currency` column option."},"attachment_option":{"title":"attachment_option","required":["layout"],"type":"object","properties":{"layout":{"type":"string","description":"The attachment layout.","example":"thumbnail","enum":["thumbnail","full_width"]}},"description":"The `attachment` column option."},"url_option":{"title":"url_option","required":["display_type","open_type"],"type":"object","properties":{"display_type":{"type":"string","description":"The URL display type.","example":"title","enum":["title","full","icon"]},"open_type":{"type":"string","description":"The URL open type.","example":"current_page","enum":["current_page","new_page"]}},"description":"The `url` column option."}},"description":"The corresponding relationship between column type and column option is as follows:\n\n`date`|`created_time`|`updated_time`: date_option\n`number`: number_option\n`currency`: currency_option\n`percent`: percent_option\n`url`: url_option\n`attachment`: attachment_option\n`reaction`: reaction_option\n`single_select`|`multiple_select`: select_option\n`people`: people_option\n\nOther column types do not have a column option."}}}}}},"responses":{"201":{"description":"**HTTP Status Code:** `201` Created. The new column of the data table is returned.","content":{"application/json":{"schema":{"required":["column_id","column_type","integrated","name"],"type":"object","properties":{"column_id":{"type":"string","description":"The ID of the column.","example":"cacdc418655a4d5b8ca6c6b5e5dab07b"},"name":{"type":"string","description":"The name of the column.","example":"Text"},"description":{"type":"string","description":"Column Description","example":"Text Content"},"column_type":{"type":"string","description":"The type of the column.","example":"text","enum":["text","number","percent","single_select","multiple_select","date","people","checkbox","attachment","reaction","created_by","updated_by","created_time","updated_time","currency","page","url"]},"column_options":{"type":"object","properties":{"date_option":{"title":"date_option","required":["format","is_24_hour_format"],"type":"object","properties":{"format":{"type":"string","description":"The date display format. Specific examples are as follows:\n2025-10-21 12:00\n2025/10/21 12:00\n2025/10/21 00:00\n25-10-21 00:30\n10/21/2025 00:30\n10/21/25 00:30\n08/10/2025 01:00\n08/10/25 01:00","example":"MM/dd/yyyy","enum":["MM/dd/yyyy","MM/dd/yy","M/d/yyyy","yy-MM-dd","yyyy/MM/dd","yy/MM/dd","yyyy/M/d","yy/M/d","dd/MM/yyyy","dd/MM/yy","MMM d, yyyy","EEE, MMM d","EEE, MMM d, yyyy","EEE"]},"is_24_hour_format":{"type":"boolean","description":"If `true`, display in 24-hour format. If `false`, display in 12-hour format.","example":false}},"description":"The `date`|`created_time`|`updated_time` column option."},"number_option":{"title":"number_option","required":["decimal","show_separator"],"type":"object","properties":{"decimal":{"type":"integer","description":"The number of decimal places.","example":1,"enum":[0,1,2,3,4,5]},"show_separator":{"type":"boolean","description":"If `true`, display thousand separators. If `false`, do not display thousand separators.","example":false}},"description":"The `number` column option."},"select_option":{"title":"select_option","type":"object","properties":{"options":{"type":"array","description":"The option list.","items":{"type":"object","properties":{"name":{"type":"string","description":"The name of an option.","example":"Blue"},"id":{"type":"string","description":"The ID of an option.","example":"h45x4NDzVprZUu6t"}},"description":"The specific name of an option."}}},"description":"The `single_select` and `multiple_select` column option."},"percent_option":{"title":"percent_option","required":["decimal","show_progress_bar"],"type":"object","properties":{"decimal":{"type":"integer","description":"The number of decimal places.","example":1,"enum":[0,1,2,3,4,5]},"show_progress_bar":{"type":"boolean","description":"If `true`, display the progress bar. If `false`, do not display the progress bar.","example":false}},"description":"The `percent` column option."},"people_option":{"title":"people_option","required":["is_multiple","is_notify"],"type":"object","properties":{"is_multiple":{"type":"boolean","description":"If `true`, allow selection of multiple people. If `false`, only one person can be selected.","example":false},"is_notify":{"type":"boolean","description":"If `true`, send a notification message after selecting someone. If `false`, do not send a notification message after selecting someone.","example":false}},"description":"The `people` column option."},"reaction_option":{"title":"reaction_option","required":["allow_commenter_react","display_type","icon"],"type":"object","properties":{"icon":{"required":["type","value"],"type":"object","properties":{"type":{"type":"string","description":"The icon display type. Currently only supports emoji.","example":"emoji","enum":["emoji"]},"value":{"type":"string","description":"The icon value.","example":"👍","enum":["👍","👎","🌟"]}},"description":"The icon content."},"display_type":{"type":"string","description":"The reaction icon display type.","example":"number","enum":["number","people","none"]},"allow_commenter_react":{"type":"boolean","description":"Whether a user with only commenter permission is allowed to click. If `true`, the user is allowed to click. If `false`, the user is not allowed to click.","example":false}},"description":"The `reaction` column option."},"currency_option":{"title":"currency_option","required":["decimal","format","symbol"],"type":"object","properties":{"decimal":{"type":"integer","description":"The number of decimal places.","example":1,"enum":[0,1,2,3,4,5]},"symbol":{"type":"string","description":"The currency symbol.","example":"$","enum":["$","¥","€","Ft","Rp","kr","R","CHF","DH","₹","zł","₽","₩","฿","₺","£"]},"format":{"type":"string","description":"The currency format.","example":"accounting","enum":["accounting","currency"]}},"description":"The `currency` column option."},"attachment_option":{"title":"attachment_option","required":["layout"],"type":"object","properties":{"layout":{"type":"string","description":"The attachment layout.","example":"thumbnail","enum":["thumbnail","full_width"]}},"description":"The `attachment` column option."},"url_option":{"title":"url_option","required":["display_type","open_type"],"type":"object","properties":{"display_type":{"type":"string","description":"The URL display type.","example":"title","enum":["title","full","icon"]},"open_type":{"type":"string","description":"The URL open type.","example":"current_page","enum":["current_page","new_page"]}},"description":"The `url` column option."}},"description":"The corresponding relationship between column type and column option is as follows:\n\n`date`|`created_time`|`updated_time`: date_option\n`number`: number_option\n`currency`: currency_option\n`percent`: percent_option\n`url`: url_option\n`attachment`: attachment_option\n`reaction`: reaction_option\n`single_select`|`multiple_select`: select_option\n`people`: people_option\n\nOther column types do not have a column option."},"integrated":{"type":"boolean","description":"If `true`, this column is an integrated column and cannot be edited by the user. If `false`, the user can edit it.","example":false}}}}}},"400":{"description":"**HTTP Status Code:** `400` <br>\n Bad Request  Invalid parameters. \n\n **Error Code:** `2012` <br>\n Unsupported column type. <br>\n"},"403":{"description":"**HTTP Status Code:** `403` <br>\n Forbidden  Permission denied. \n\n **Error Code:** `2009` <br>\n No permission to access or modify this resource. <br>\n"},"404":{"description":"**HTTP Status Code:** `404` <br>\n Not Found  File or data table 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_authorization":[]}],"x-extensions":{"x-permissions":[],"x-macro-scopes":["canvas_data_table:write"],"x-granular-scopes":["canvas:write:data_table"]}}},"/docs/files/{fileId}/data_tables/{tableId}/columns/{columnId}":{"delete":{"tags":["DataTable Content"],"summary":"Delete a column","description":"Delete a column from a table.\n\n**[Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `canvas_data_table:delete`\n\n**[Granular Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `canvas:delete:data_table`\n\n**[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `MEDIUM`\n\n**Not supported in Gov cluster** ","operationId":"Deleteacolumn","parameters":[{"name":"fileId","in":"path","description":"The file ID of the data table where the column to be deleted is located.","required":true,"schema":{"type":"string","example":"B6gebVLnRaOEVvVLfHlMSA"}},{"name":"tableId","in":"path","description":"The table ID.","required":true,"schema":{"type":"string","example":"26c5f77db1764c998148ccd7b70af3d2"}},{"name":"columnId","in":"path","description":"The ID of the column to be deleted.","required":true,"schema":{"type":"string","example":"44879b1a2ee54ada9426b82c2e654c74"}}],"responses":{"204":{"description":"Column deleted successfully."},"400":{"description":"**HTTP Status Code:** `400` <br>\n Bad Request  Invalid parameters. \n\n "},"403":{"description":"**HTTP Status Code:** `403` <br>\n Forbidden  No permission. \n\n **Error Code:** `2009` <br>\n No permission to access or modify this resource. <br>\n"},"404":{"description":"**HTTP Status Code:** `404` <br>\n Not Found  Table or column not found. \n\n **Error Code:** `2000` <br>\n Block 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_authorization":[]}],"x-extensions":{"x-permissions":[],"x-macro-scopes":["canvas_data_table:delete"],"x-granular-scopes":["canvas:delete:data_table"]}},"patch":{"tags":["DataTable Content"],"summary":"Update a column","description":"Update a column.\n\n**[Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `canvas_data_table:update`\n\n**[Granular Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `canvas:update:data_table`\n\n**[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `MEDIUM`\n\n**Not supported in Gov cluster** ","operationId":"Updateacolumn","parameters":[{"name":"fileId","in":"path","description":"The file ID of the data table where the column to be updated is located.","required":true,"schema":{"type":"string","example":"B6gebVLnRaOEVvVLfHlMSA"}},{"name":"tableId","in":"path","description":"The table ID.","required":true,"schema":{"type":"string","example":"2c3761cd5da242a59600180683e1ad8d"}},{"name":"columnId","in":"path","description":"The ID of the data table column.","required":true,"schema":{"type":"string","example":"da2865fc08234a76aa60912147e9b442"}}],"requestBody":{"content":{"application/json":{"schema":{"type":"object","properties":{"name":{"type":"string","description":"The column name.","example":"Text"},"description":{"type":"string","description":"Column Description","example":"Display national place names"},"column_options":{"type":"object","properties":{"date_option":{"title":"date_option","required":["format","is_24_hour_format"],"type":"object","properties":{"format":{"type":"string","description":"The date display format. Specific examples are as follows:\n2025-10-21 12:00\n2025/10/21 12:00\n2025/10/21 00:00\n25-10-21 00:30\n10/21/2025 00:30\n10/21/25 00:30\n08/10/2025 01:00\n08/10/25 01:00","example":"MM/dd/yyyy","enum":["MM/dd/yyyy","MM/dd/yy","M/d/yyyy","yy-MM-dd","yyyy/MM/dd","yy/MM/dd","yyyy/M/d","yy/M/d","dd/MM/yyyy","dd/MM/yy","MMM d, yyyy","EEE, MMM d","EEE, MMM d, yyyy","EEE"]},"is_24_hour_format":{"type":"boolean","description":"If `true`, display in 24-hour format. If `false`, display in 12-hour format.","example":false}},"description":"The `date`|`created_time`|`updated_time` column option."},"number_option":{"title":"number_option","required":["decimal","show_separator"],"type":"object","properties":{"decimal":{"type":"integer","description":"The number of decimal places.","example":1,"enum":[0,1,2,3,4,5]},"show_separator":{"type":"boolean","description":"If `true`, display thousand separators. If `false`, do not display thousand separators.","example":false}},"description":"The `number` column option."},"select_option":{"title":"select_option","type":"object","properties":{"create_options":{"type":"array","description":"The list of new options to be added.","items":{"type":"string","description":"The option name.","example":"Todo"}},"update_options":{"type":"array","description":"The list of options to be updated.","items":{"type":"object","properties":{"option_id":{"type":"string","description":"The option ID.","example":"U9QOO6U4s8gBu0Zl"},"option_name":{"type":"string","description":"The option name.","example":"Done"}},"description":"The option information."}}},"description":"The `single_select` and `multiple_select` column option.\nOnly supports adding new options and modifying existing ones; deleting options is not supported."},"percent_option":{"title":"percent_option","required":["decimal","show_progress_bar"],"type":"object","properties":{"decimal":{"type":"integer","description":"The number of decimal places.","example":1,"enum":[0,1,2,3,4,5]},"show_progress_bar":{"type":"boolean","description":"If `true`, display the progress bar. If `false`, do not display the progress bar.","example":false}},"description":"The `percent` column option."},"people_option":{"title":"people_option","required":["is_multiple","is_notify"],"type":"object","properties":{"is_multiple":{"type":"boolean","description":"If `true`, allow selection of multiple people. If `false`, only one person can be selected.","example":false},"is_notify":{"type":"boolean","description":"If `true`, send a notification message after selecting someone. If `false`, do not send a notification message after selecting someone.","example":false}},"description":"The `people` column option."},"reaction_option":{"title":"reaction_option","required":["allow_commenter_react","display_type","icon"],"type":"object","properties":{"icon":{"required":["type","value"],"type":"object","properties":{"type":{"type":"string","description":"The icon display type. Currently only supports emoji.","example":"emoji","enum":["emoji"]},"value":{"type":"string","description":"The icon value.","example":"👍","enum":["👍","👎","🌟"]}},"description":"The icon content."},"display_type":{"type":"string","description":"The reaction icon display type.","example":"number","enum":["number","people","none"]},"allow_commenter_react":{"type":"boolean","description":"Whether a user with only commenter permission is allowed to click. If `true`, the user is allowed to click. If `false`, the user is not allowed to click.","example":false}},"description":"The `reaction` column option."},"currency_option":{"title":"currency_option","required":["decimal","format","symbol"],"type":"object","properties":{"decimal":{"type":"integer","description":"The number of decimal places.","example":1,"enum":[0,1,2,3,4,5]},"symbol":{"type":"string","description":"The currency symbol.","example":"$","enum":["$","¥","€","Ft","Rp","kr","R","CHF","DH","₹","zł","₽","₩","฿","₺","£"]},"format":{"type":"string","description":"The currency format.","example":"accounting","enum":["accounting","currency"]}},"description":"The `currency` column option."},"attachment_option":{"title":"attachment_option","required":["layout"],"type":"object","properties":{"layout":{"type":"string","description":"The attachment layout.","example":"thumbnail","enum":["thumbnail","full_width"]}},"description":"The `attachment` column option."},"url_option":{"title":"url_option","required":["display_type","open_type"],"type":"object","properties":{"display_type":{"type":"string","description":"The URL display type.","example":"title","enum":["title","full","icon"]},"open_type":{"type":"string","description":"The URL open type.","example":"current_page","enum":["current_page","new_page"]}},"description":"The `url` column option."}},"description":"When updating columns, update only the necessary options; there is no need to update all of them.\n\nThe corresponding relationship between column type and column option is as follows:\n\n`date`|`created_time`|`updated_time`: date_option\n`number`: number_option\n`currency`: currency_option\n`percent`: percent_option\n`url`: url_option\n`attachment`: attachment_option\n`reaction`: reaction_option\n`single_select`|`multiple_select`: select_option\n`people`: people_option\n\nOther column types do not have a column option."},"column_type":{"type":"string","description":"If the column type needs to be modified, pass the new column type here. If the target column type requires column options, pass the column options as well.","example":"text","enum":["text","number","percent","single_select","multiple_select","date","people","checkbox","attachment","reaction","created_by","updated_by","created_time","updated_time","currency","page","url"]}}}}}},"responses":{"204":{"description":"Successfully updated the column of the table."},"400":{"description":"**HTTP Status Code:** `400` <br>\n Bad Request  Invalid parameters. \n\n **Error Code:** `2012` <br>\n Unsupported column type. <br>\n"},"403":{"description":"**HTTP Status Code:** `403` <br>\n Forbidden  No permission. \n\n **Error Code:** `2009` <br>\n Updating column type is not allowed. <br>\n"},"404":{"description":"**HTTP Status Code:** `404` <br>\n Not Found  Data table or column not found. \n\n **Error Code:** `2000` <br>\n Block 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_authorization":[]}],"x-extensions":{"x-permissions":[],"x-macro-scopes":["canvas_data_table:update"],"x-granular-scopes":["canvas:update:data_table"]}}},"/docs/files/{fileId}/data_tables/{tableId}/rows":{"post":{"tags":["DataTable Content"],"summary":"Create table rows","description":"Add rows to a table.\nCreate up to 10 rows at a time.\n\n**[Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `canvas_data_table:write`\n\n**[Granular Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `canvas:write:data_table`\n\n**[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `MEDIUM`\n\n**Not supported in Gov cluster** ","operationId":"Createdatatablerows","parameters":[{"name":"fileId","in":"path","description":"The file ID.","required":true,"schema":{"type":"string","example":"ADuV705lSXW4c6fBgQFarQ"}},{"name":"tableId","in":"path","description":"The table ID.","required":true,"schema":{"type":"string","example":"f537cdc592524388ae6651f9e97fe860"}}],"requestBody":{"content":{"application/json":{"schema":{"required":["rows"],"type":"object","properties":{"rows":{"maxItems":10,"minItems":1,"type":"array","description":"Array of table rows.","items":{"required":["cells"],"type":"object","properties":{"cells":{"type":"array","description":"Array of cell values in a row.","items":{"required":["column_name","value"],"type":"object","properties":{"column_name":{"type":"string","description":"The column name. Each cell value corresponds to a column.","example":"Text"},"value":{"type":"object","properties":{"text":{"title":"text","type":"string","description":"The `text` cell value.","example":"Hello World!"},"number":{"title":"number","type":"number","description":"The `number` cell value.","example":12.14},"percent":{"title":"percent","type":"number","description":"The `percent` cell value.\nThe calculation is based on percentage. For example, 200 represents 200%, and 1 represents 1%.","example":200},"single_select":{"title":"single_select","type":"string","description":"The `single_select` cell value.","example":"Male"},"multiple_select":{"title":"multi_select","type":"array","description":"The `multiple_select` cell value.","items":{"type":"string","example":"Male"}},"date":{"title":"date","type":"string","description":"The `date` cell value. An ISO 8601 formatted date string in UTC.","example":"2025-07-03T05:52:37Z"},"people":{"title":"people","type":"array","description":"The `people` cell value. If the `people` column's `is_multiple` is `true`, multiple people entries can be specified; otherwise, only one is allowed.","items":{"type":"object","properties":{"user_id":{"type":"string","description":"The user ID.","example":"U3OwWitcRAShLhbG4ChXNQ"}},"description":"A people item."}},"checkbox":{"title":"checkbox","type":"boolean","description":"The `checkbox` cell value. Whether the checkbox is checked: `true` or `false`.","example":false},"reaction":{"title":"reaction","type":"string","description":"The `reaction` cell value.","example":"click","enum":["click","unclick"]},"currency":{"title":"currency","type":"number","description":"The `currency` cell value.","example":20000},"url":{"title":"url","type":"string","description":"The `url` cell value.","example":"https://www.google.com"},"attachment":{"title":"attachment","type":"array","description":"The `attachment` cell value.\n\nYou must first call the [Upload file for docs import or attachments](/docs/api-reference/zoom-api/methods#operation/uploadDocsFile) API to upload the attachment, get the **attachment_id**, and then fill it into the cell value. Multiple **attachment_id** values can be specified.\n\nImage attachments are not allowed.","items":{"type":"object","properties":{"attachment_id":{"type":"string","description":"The attachment ID.","example":"ql62c9GzTdywOfRiaj6imQ"}},"description":"An attachment item."}}},"description":"A single `column_name` corresponds to only one `value`, and the relationship between each `value` and its `column_type` is as follows:\n\n`text`: `text` column\n`number`: `number` column\n`currency`: `currency` column\n`percent`: `percent` column\n`date`: `date` column\n`url`: `url` column\n`people`: `people` column\n`reaction`: `reaction` column\n`attachment`: `attachment` column\n`single_select`: `single_select` column\n`multiple_select`: `multiple_select` column\n`checkbox`: `checkbox` column\n\n`page`, `relation`, `formula`, and `rollup` cell values are not supported. The `created_time`, `updated_time`, `created_by`, and `updated_by` values are automatically generated by the system."}},"description":"The cell in the row corresponds to a column in the data table, and its value should match the type of that column."}}},"description":"A row of data to be created."}}}}}}},"responses":{"201":{"description":"**HTTP Status Code:** `201`  Created rows of the data table returned.","content":{"application/json":{"schema":{"type":"object","properties":{"rows":{"type":"array","description":"Array of table rows.","items":{"required":["cells","row_id"],"type":"object","properties":{"cells":{"type":"array","description":"Array of cell values in a row.","items":{"required":["column_name","value"],"type":"object","properties":{"column_name":{"type":"string","description":"The column name. Each cell value corresponds to a column.","example":"Text"},"value":{"type":"object","properties":{"text":{"title":"text","type":"string","description":"The `text` cell value.","example":"Hello World!"},"number":{"title":"number","type":"number","description":"The `number` cell value.","example":12.14},"percent":{"title":"percent","type":"number","description":"The `percent` cell value.\nThe calculation is based on percentage. For example, 200 represents 200%, and 1 represents 1%.","example":200},"single_select":{"title":"single_select","type":"string","description":"The `single_select` cell value.","example":"Male"},"multiple_select":{"title":"multi_select","type":"array","description":"The `multiple_select` cell value.","items":{"type":"string","example":"Male"}},"date":{"title":"date","type":"string","description":"The `date` cell value. An ISO 8601 formatted date string in UTC.","example":"2025-07-03T05:52:37Z"},"people":{"title":"people","type":"array","description":"The `people` cell value. If the `people` column's `is_multiple` is `true`, multiple people entries can be specified; otherwise, only one is allowed.","items":{"type":"object","properties":{"user_id":{"type":"string","description":"The user ID.","example":"U3OwWitcRAShLhbG4ChXNQ"},"user_name":{"type":"string","description":"The user name.","example":"Jack Li"}},"description":"A people item."}},"checkbox":{"title":"checkbox","type":"boolean","description":"The `checkbox` cell value. Whether the checkbox is checked: `true` or `false`.","example":false},"reaction":{"title":"reaction","type":"array","description":"The `reaction` cell value.","items":{"type":"object","properties":{"user_id":{"type":"string","description":"The user ID.","example":"GUZs4XBmSXqP6WLfEl_PSg"},"user_name":{"type":"string","description":"The user name.","example":"Jack Li"}},"description":"A reaction item."}},"currency":{"title":"currency","type":"number","description":"The `currency` cell value.","example":20000},"url":{"title":"url","type":"string","description":"The `url` cell value.","example":"https://www.google.com"},"attachment":{"title":"attachment","type":"array","description":"The `attachment` cell value.\n\nYou must first call the [Upload file for docs import or attachments](/docs/api-reference/zoom-api/methods#operation/uploadDocsFile) API to upload the attachment, get the **attachment_id**, and then fill it into the cell value. Multiple **attachment_id** values can be specified.\n\nImage attachments are not allowed.","items":{"type":"object","properties":{"attachment_id":{"type":"string","description":"The attachment ID.","example":"ql62c9GzTdywOfRiaj6imQ"},"name":{"type":"string","description":"The attachment name.","example":"api.txt"},"type":{"type":"string","description":"The attachment type.","example":"txt"}},"description":"An attachment item."}}},"description":"The column types corresponding to each cell value are as follows:\n\n`text`: `text` column\n`number`: `number` column\n`currency`: `currency` column\n`percent`: `percent` column\n`date`: `date` column\n`url`: `url` column\n`people`: `people` column\n`reaction`: `reaction` column\n`attachment`: `attachment` column\n`single_select`: `single_select` column\n`multiple_select`: `multiple_select` column\n`checkbox`: `checkbox` column\n\n`page`, `relation`, `formula`, and `rollup` cell values are not supported. The `created_time`, `updated_time`, `created_by`, and `updated_by` values are automatically generated by the system."}},"description":"The cell in the row corresponds to a column in the data table, and its value should match the type of that column."}},"row_id":{"type":"string","description":"The row ID.","example":"f537cdc592524388ae6651f9e97fe860"}},"description":"A row of data that was created."}}}}}}},"400":{"description":"**HTTP Status Code:** `400` <br>\n Bad Request  Invalid parameters. \n\n **Error Code:** `2105` <br>\n Row count can not be greater than 10. <br>\n**Error Code:** `2026` <br>\n Invalid or inaccessible link URL. <br>\n**Error Code:** `2012` <br>\n Unsupported column type. <br>\n"},"401":{"description":"**HTTP Status Code:** `401` <br>\n Unauthorized  User not found or authentication failed. \n\n "},"403":{"description":"**HTTP Status Code:** `403` <br>\n Forbidden  Permission denied. \n\n **Error Code:** `2009` <br>\n No permission to access or modify this resource. <br>\n"},"404":{"description":"**HTTP Status Code:** `404` <br>\n Not Found  File or data table not found. \n\n **Error Code:** `2000` <br>\n Block not found. <br>\n"},"415":{"description":"**HTTP Status Code:** `415` <br>\n Unsupported Media Type  Unsupported image attachment. \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_authorization":[]}],"x-extensions":{"x-permissions":[],"x-macro-scopes":["canvas_data_table:write"],"x-granular-scopes":["canvas:write:data_table"]}},"delete":{"tags":["DataTable Content"],"summary":"Delete rows","description":"Batch delete rows. Delete up to 10 rows at a time.\n\n**[Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `canvas_data_table:delete`\n\n**[Granular Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `canvas:delete:data_table`\n\n**[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `MEDIUM`\n\n**Not supported in Gov cluster** ","operationId":"Deleterows","parameters":[{"name":"fileId","in":"path","description":"The file ID of the data table where the rows to be deleted are located.","required":true,"schema":{"type":"string","example":"B6gebVLnRaOEVvVLfHlMSA"}},{"name":"tableId","in":"path","description":"The table ID.","required":true,"schema":{"type":"string","example":"68cdb0c4a3ea494dbcf752e7b1ef12f3"}},{"name":"row_ids","in":"query","description":"List of row IDs, separated by commas.","required":true,"schema":{"type":"string","example":"e4d94cdba16143f3a7a312a6f674006c,70a8142285b44035a9a876202fdd6895"}}],"responses":{"204":{"description":"Rows deleted successfully."},"400":{"description":"**HTTP Status Code:** `400` <br>\n Bad Request  Invalid Parameters. \n\n "},"403":{"description":"**HTTP Status Code:** `403` <br>\n Forbidden  No Permission. \n\n **Error Code:** `2009` <br>\n No permission to access or modify this resource. <br>\n"},"404":{"description":"**HTTP Status Code:** `404` <br>\n Not Found  Table or Row not found. \n\n **Error Code:** `2000` <br>\n Table row 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_authorization":[]}],"x-extensions":{"x-permissions":[],"x-macro-scopes":["canvas_data_table:delete"],"x-granular-scopes":["canvas:delete:data_table"]}},"patch":{"tags":["DataTable Content"],"summary":"Update rows","description":"Update rows of the table. A maximum of 10 rows can be updated at one time.\n\n**[Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `canvas_data_table:update`\n\n**[Granular Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `canvas:update:data_table`\n\n**[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `MEDIUM`\n\n**Not supported in Gov cluster** ","operationId":"Updaterows","parameters":[{"name":"fileId","in":"path","description":"The file ID of the table.","required":true,"schema":{"type":"string","example":"B6gebVLnRaOEVvVLfHlMSA"}},{"name":"tableId","in":"path","description":"The table ID.","required":true,"schema":{"type":"string","example":"f537cdc592524388ae6651f9e97fe860"}}],"requestBody":{"content":{"application/json":{"schema":{"required":["rows"],"type":"object","properties":{"rows":{"maxItems":10,"minItems":1,"type":"array","description":"Array of table rows.","items":{"required":["cells","row_id"],"type":"object","properties":{"cells":{"type":"array","description":"The list of cells to update in this row. Include only the columns whose values need to be changed. Columns that are not included remain unchanged.","items":{"required":["column_name","value"],"type":"object","properties":{"column_name":{"type":"string","description":"The column name. Each cell value corresponds to a column.","example":"Text"},"value":{"type":"object","properties":{"text":{"title":"text","type":"string","description":"The `text` cell value.","example":"Hello World!"},"number":{"title":"number","type":"number","description":"The `number` cell value.","example":12.14},"percent":{"title":"percent","type":"number","description":"The `percent` cell value.\nThe calculation is based on percentage. For example, 200 represents 200%, and 1 represents 1%.","example":200},"single_select":{"title":"single_select","type":"string","description":"The `single_select` cell value.","example":"Male"},"multiple_select":{"title":"multi_select","type":"array","description":"The `multiple_select` cell value.","items":{"type":"string","example":"Male"}},"date":{"title":"date","type":"string","description":"The `date` cell value. The ISO 8601 formatted date string in UTC.","example":"2025-07-03T05:52:37Z"},"people":{"title":"people","type":"array","description":"The `people` cell value. If the `people` column's `is_multiple` is `true`, multiple people entries can be specified; otherwise, only one is allowed.","items":{"type":"object","properties":{"user_id":{"type":"string","description":"The user ID.","example":"U3OwWitcRAShLhbG4ChXNQ"}},"description":"A people item."}},"checkbox":{"title":"checkbox","type":"boolean","description":"The `checkbox` cell value. Whether the checkbox is checked: `true` or `false`.","example":false},"reaction":{"title":"reaction","type":"string","description":"The `reaction` cell value.","example":"click","enum":["click","unclick"]},"currency":{"title":"currency","type":"number","description":"The `currency` cell value.","example":20000},"url":{"title":"url","type":"string","description":"The `url` cell value.","example":"https://www.google.com"},"attachment":{"title":"attachment","type":"array","description":"The `attachment` cell value.\n\nYou must first call the `Upload file for docs import or attachments` API to upload the attachment, get the **attachment_id**, and then fill it into the cell value. Multiple **attachment_id** values can be specified.\n\nImage attachments are not allowed.","items":{"type":"object","properties":{"attachment_id":{"type":"string","description":"The attachment ID.","example":"ql62c9GzTdywOfRiaj6imQ"}},"description":"An attachment item."}}},"description":"A single `column_name` corresponds to only one `value`, and the relationship between each `value` and its `column_type` is as follows:\n\n`text`: `text` column\n`number`: `number` column\n`currency`: `currency` column\n`percent`: `percent` column\n`date`: `date` column\n`url`: `url` column\n`people`: `people` column\n`reaction`: `reaction` column\n`attachment`: `attachment` column\n`single_select`: `single_select` column\n`multiple_select`: `multiple_select` column\n`checkbox`: `checkbox` column\n\n`page`, `relation`, `formula`, and `rollup` cell values are not supported. The `created_time`, `updated_time`, `created_by`, and `updated_by` values are automatically generated by the system."}},"description":"The cell in the row corresponds to a column in the data table, and its value should match the type of that column."}},"row_id":{"type":"string","description":"The row ID.","example":"f537cdc592524388ae6651f9e97fe860"}},"description":"A row of data to be updated."}}}}}}},"responses":{"204":{"description":"Rows updated successfully."},"400":{"description":"**HTTP Status Code:** `400` <br>\n Bad Request  Invalid parameters. \n\n **Error Code:** `2000` <br>\n Block not found. <br>\n**Error Code:** `2105` <br>\n Row count cannot be greater than 10. <br>\n**Error Code:** `2026` <br>\n Invalid or inaccessible link URL. <br>\n"},"401":{"description":"**HTTP Status Code:** `401` <br>\n Unauthorized  User not found or authentication failed. \n\n "},"403":{"description":"**HTTP Status Code:** `403` <br>\n Forbidden  No permission. \n\n **Error Code:** `2009` <br>\n No permission to access or modify this resource. <br>\n"},"404":{"description":"**HTTP Status Code:** `404` <br>\n Not Found  Data table or rows not found. \n\n **Error Code:** `2000` <br>\n Block not found. <br>\n"},"415":{"description":"**HTTP Status Code:** `415` <br>\n Unsupported Media Type  Unsupported image attachment. \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_authorization":[]}],"x-extensions":{"x-permissions":[],"x-macro-scopes":["canvas_data_table:update"],"x-granular-scopes":["canvas:update:data_table"]}}},"/docs/files/{fileId}/data_tables/{tableId}/rows/query":{"post":{"tags":["DataTable Content"],"summary":"Search rows","description":"Retrieve rows from a table with pagination, sorting, field selection, and filtering. A maximum of 100 rows are returned at a time.\n\n**[Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `canvas_data_table:read`\n\n**[Granular Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `canvas:read:data_table`\n\n**[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `MEDIUM`\n\n**Not supported in Gov cluster** ","operationId":"Searchrows","parameters":[{"name":"fileId","in":"path","description":"The file ID of the data table where the rows to be queried are located.","required":true,"schema":{"type":"string","example":"B6gebVLnRaOEVvVLfHlMSA"}},{"name":"tableId","in":"path","description":"The table ID.","required":true,"schema":{"type":"string","example":"6f56440fb19348d1a11ec9c1a5319bce"}},{"name":"next_page_token","in":"query","description":"Use the `next_page_token` to paginate through a large set of results. A `next_page_token` is returned when the set of available results exceeds the current page size.","required":false,"schema":{"type":"string","example":"Tva2CuIdTgsv8wAnhyAdU3m06Y2HuLQtlh3"}},{"name":"page_size","in":"query","description":"The query page size. The default is 10.","required":false,"schema":{"maximum":50,"minimum":10,"type":"integer","example":10}}],"requestBody":{"content":{"application/json":{"schema":{"type":"object","properties":{"filters":{"type":"object","description":"# Filter Structure\n\n## 1. Logical Group (`and` / `or`)\n\n```json\n{\n  \"and\": [\n    { \"column_name\": \"Status\", \"operator\": \"equal\", \"value\": { \"single_select\": \"Done\" } },\n    { \"column_name\": \"Priority\", \"operator\": \"greater_than\", \"value\": { \"number\": 3 } }\n  ]\n}\n```\n\n## 2. Nested Group (max 2 levels)\n\n```json\n{\n  \"and\": [\n    { \"column_name\": \"Status\", \"operator\": \"equal\", \"value\": { \"single_select\": \"Done\" } },\n    {\n      \"or\": [\n        { \"column_name\": \"Priority\", \"operator\": \"equal\", \"value\": { \"number\": 1 } },\n        { \"column_name\": \"Priority\", \"operator\": \"equal\", \"value\": { \"number\": 2 } }\n      ]\n    }\n  ]\n}\n```\n\n---\n\n# Condition Fields\n\n\n| Key        | Type     | Required | Description                                                                                                                                   |\n| ---------- | -------- | -------- | --------------------------------------------------------------------------------------------------------------------------------------------- |\n| `column_name` | `string` | **Yes**  | The column name.                                                                                                                              |\n| `operator` | `string` | **Yes**  | The filter operator (see below).                                                                                                              |\n| `value`    | `object` | No       | The filter value. **Not required** when `operator` is `is_empty` or `is_not_empty`. Only **one key** should be set, matching the column type. |\n\n\n---\n\n# Filter Operators\n\n\n| Operator             | Description                       |\n| -------------------- | --------------------------------- |\n| `equal`              | Equal to                          |\n| `not_equal`          | Not equal to                      |\n| `greater_than`       | Greater than                      |\n| `greater_than_equal` | Greater than or equal to          |\n| `less_than`          | Less than                         |\n| `less_than_equal`    | Less than or equal to             |\n| `contains`           | Contains                          |\n| `not_contains`       | Does not contain                  |\n| `is_empty`           | Is empty (no `value` needed)      |\n| `is_not_empty`       | Is not empty (no `value` needed)  |\n| `starts_with`        | Starts with                       |\n| `ends_with`          | Ends with                         |\n| `contains_any_of`    | Contains any of the given values  |\n| `contains_none_of`   | Contains none of the given values |\n| `contains_all_of`    | Contains all of the given values  |\n\n\n---\n\n# Value Format by Column Type\n\n## `text`\n\n- **Format:** `{ \"text\": \"Hello World!\" }`\n- **Operators:** `is_empty`, `is_not_empty`, `equal`, `not_equal`, `contains`, `not_contains`, `starts_with`, `ends_with`\n\n## `number`\n\n- **Format:** `{ \"number\": 12.14 }`\n- **Operators:** `is_empty`, `is_not_empty`, `equal`, `not_equal`, `greater_than`, `greater_than_equal`, `less_than`, `less_than_equal`\n\n## `percent`\n\n- **Format:** `{ \"percent\": 200 }`\n- **Note:** 200 means 200%, 1 means 1%.\n- **Operators:** Same as `number`.\n\n## `currency`\n\n- **Format:** `{ \"currency\": 20000 }`\n- **Operators:** Same as `number`.\n\n## `single_select`\n\n- **Format:** `{ \"single_select\": \"Male\" }`\n- **Note:** Value is the **option name**.\n- **Operators:** `is_empty`, `is_not_empty`, `equal`, `not_equal`, `contains_any_of`, `contains_none_of`\n\n## `multiple_select`\n\n- **Format:** `{ \"multiple_select\": [\"Tag1\", \"Tag2\"] }`\n- **Note:** Value is an **array of option names**.\n- **Operators:** `is_empty`, `is_not_empty`, `equal`, `contains_any_of`, `contains_all_of`, `contains_none_of`\n\n## `date`\n\n- **Format:** `{ \"date\": { \"mode\": \"<mode>\", \"value\": \"<value>\" } }`\n- **`mode` is required.** The `value` field depends on the mode:\n\n\n| Mode          | `value`                       | Example                                                  |\n| ------------- | ----------------------------- | -------------------------------------------------------- |\n| `exactly`     | ISO 8601 date string          | `{ \"mode\": \"exactly\", \"value\": \"2025-07-03T05:52:37Z\" }` |\n| `past`        | Number of days ago (string)   | `{ \"mode\": \"past\", \"value\": \"3\" }`                       |\n| `next`        | Number of days ahead (string) | `{ \"mode\": \"next\", \"value\": \"7\" }`                       |\n| `today`       | Not required                  | `{ \"mode\": \"today\" }`                                    |\n| `yesterday`   | Not required                  | `{ \"mode\": \"yesterday\" }`                                |\n| `tomorrow`    | Not required                  | `{ \"mode\": \"tomorrow\" }`                                 |\n| `currentweek` | Not required                  | `{ \"mode\": \"currentweek\" }`                              |\n\n\n- **Operators:** `is_empty`, `is_not_empty`, `equal`, `not_equal`, `greater_than`, `greater_than_equal`, `less_than`, `less_than_equal`\n- **Examples:**\n  - Greater than current week: `\"operator\": \"greater_than\"`, `\"value\": { \"date\": { \"mode\": \"currentweek\" } }`\n  - Less than a specific date: `\"operator\": \"less_than\"`, `\"value\": { \"date\": { \"mode\": \"exactly\", \"value\": \"2025-07-03T05:52:37Z\" } }`\n  - Greater than 3 days ago: `\"operator\": \"greater_than\"`, `\"value\": { \"date\": { \"mode\": \"past\", \"value\": \"3\" } }`\n\n## `people`\n\n- **Format:** `{ \"people\": [\"U3OwWitcRAShLhbG4ChXNQ\"] }`\n- **Note:** Value is an **array of user IDs**.\n- **Operators:** `is_empty`, `is_not_empty`, `equal`, `not_equal`, `contains_any_of`, `contains_none_of`\n\n## `checkbox`\n\n- **Format:** `{ \"checkbox\": false }`\n- **Operators:** `equal`\n\n## `reaction`\n\n- **Format:** `{ \"reaction\": 12 }`\n- **Note:** Value is the **click count** (integer).\n- **Operators:** `is_empty`, `is_not_empty`, `equal`, `not_equal`, `greater_than`, `greater_than_equal`, `less_than`, `less_than_equal`\n\n## `url`\n\n- **Format:** `{ \"url\": \"https://www.google.com\" }`\n- **Operators:** `is_empty`, `is_not_empty`, `equal`, `not_equal`, `contains`, `not_contains`, `starts_with`, `ends_with`\n\n## `attachment`\n\n- **Format:** `{ \"attachment\": \"document.txt\" }`\n- **Note:** Filtering is based on the **file name**.\n- **Operators:** `is_empty`, `is_not_empty`, `equal`, `not_equal`, `contains`, `not_contains`, `starts_with`, `ends_with`\n\n"},"fields":{"type":"array","description":"If provided, only the values of the specified fields are returned. If not provided, the values of all fields are returned.","items":{"type":"string","description":"The field name.","example":"Task"}},"sort":{"type":"array","description":"The list of sorting rules.","items":{"required":["column_name","order"],"type":"object","properties":{"column_name":{"type":"string","description":"The column name to sort by.","example":"Priority"},"order":{"type":"string","description":"The sort order.","example":"asc","enum":["desc","asc"]}},"description":"A sorting rule."}}}}}}},"responses":{"200":{"description":"Successfully searched rows.","content":{"application/json":{"schema":{"required":["rows","total_records"],"type":"object","properties":{"next_page_token":{"type":"string","description":"If `next_page_token` is not empty, it indicates that there are more results. Use this token in the next request to retrieve the next page of results.","example":"Tva2CuIdTgsv8wAnhyAdU3m06Y2HuLQtlh3"},"total_records":{"type":"number","description":"The total number of rows matching the query condition.","example":50},"rows":{"type":"array","description":"The array of queried rows.","items":{"required":["cells","row_id"],"type":"object","properties":{"cells":{"type":"array","description":"The array of cell values in the row.","items":{"required":["column_name","value"],"type":"object","properties":{"column_name":{"type":"string","description":"The column name. Each cell value corresponds to a column.","example":"Text"},"value":{"type":"object","properties":{"text":{"title":"text","type":"string","description":"The `text` cell value.","example":"Hello World!"},"number":{"title":"number","type":"number","description":"The `number` cell value.","example":12.14},"percent":{"title":"percent","type":"number","description":"The `percent` cell value.\nThe calculation is based on percentage. For example, 200 represents 200%, and 1 represents 1%.","example":200},"single_select":{"title":"single_select","type":"string","description":"The `single_select` cell value.","example":"Male"},"multiple_select":{"title":"multi_select","type":"array","description":"The `multiple_select` cell value.","items":{"type":"string","example":"Male"}},"date":{"title":"date","type":"string","description":"The `date` cell value. An ISO 8601 formatted date string in UTC.","example":"2025-07-03T05:52:37Z"},"people":{"title":"people","type":"array","description":"The `people` cell value. If the `people` column's `is_multiple` is `true`, multiple people entries can be specified; otherwise, only one is allowed.","items":{"type":"object","properties":{"user_id":{"type":"string","description":"The user ID.","example":"U3OwWitcRAShLhbG4ChXNQ"},"user_name":{"type":"string","description":"The user name.","example":"Jack Li"}},"description":"A people item."}},"checkbox":{"title":"checkbox","type":"boolean","description":"The `checkbox` cell value. Whether the checkbox is checked: `true` or `false`.","example":false},"reaction":{"title":"reaction","type":"array","description":"The `reaction` cell value.","items":{"type":"object","properties":{"user_id":{"type":"string","description":"The user ID.","example":"GUZs4XBmSXqP6WLfEl_PSg"},"user_name":{"type":"string","description":"The user name.","example":"Jack Li"}},"description":"A reaction item."}},"currency":{"title":"currency","type":"number","description":"The `currency` cell value.","example":20000},"url":{"title":"url","type":"string","description":"The `url` cell value.","example":"https://www.google.com"},"attachment":{"title":"attachment","type":"array","description":"The `attachment` cell value.\n\nYou must first call the [Upload file for docs import or attachments](/docs/api-reference/zoom-api/methods#operation/uploadDocsFile) API to upload the attachment, get the **attachment_id**, and then fill it into the cell value. Multiple **attachment_id** values can be specified.\n\nImage attachments are not allowed.","items":{"type":"object","properties":{"attachment_id":{"type":"string","description":"The attachment ID.","example":"ql62c9GzTdywOfRiaj6imQ"},"name":{"type":"string","description":"The attachment name.","example":"api.txt"},"type":{"type":"string","description":"The attachment type.","example":"txt"}},"description":"An attachment item."}}},"description":"The column types corresponding to each cell value are as follows:\n\n`text`: `text` column\n`number`: `number` column\n`currency`: `currency` column\n`percent`: `percent` column\n`date`: `date` column\n`url`: `url` column\n`people`: `people` column\n`reaction`: `reaction` column\n`attachment`: `attachment` column\n`single_select`: `single_select` column\n`multiple_select`: `multiple_select` column\n`checkbox`: `checkbox` column\n\n`page`, `relation`, `formula`, and `rollup` cell values are not supported. The `created_time`, `updated_time`, `created_by`, and `updated_by` values are automatically generated by the system."}},"description":"A cell in the row that corresponds to a column in the table. Its value matches the type of that column."}},"row_id":{"type":"string","description":"The row ID.","example":"f537cdc592524388ae6651f9e97fe860"}},"description":"A row."}}}}}}},"400":{"description":"**HTTP Status Code:** `400` <br>\n Bad Request  Invalid parameters. \n\n **Error Code:** `2012` <br>\n Unsupported column type. <br>\n"},"403":{"description":"**HTTP Status Code:** `403` <br>\n Forbidden  No permission. \n\n **Error Code:** `2009` <br>\n No permission to access or modify this resource. <br>\n"},"404":{"description":"**HTTP Status Code:** `404` <br>\n Not Found  Table or rows not found. \n\n **Error Code:** `2000` <br>\n Block 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_authorization":[]}],"x-extensions":{"x-permissions":[],"x-macro-scopes":["canvas_data_table:read"],"x-granular-scopes":["canvas:read:data_table"]}}},"/docs/files/{fileId}/blocks":{"post":{"tags":["Doc Content"],"summary":"Insert blocks into a document","description":"Insert new blocks at a specific position in a document. Accepts XML-formatted block content and supports positioning above, below, or inside a specific parent block. Use the Get file content endpoint with the query parameter `format=xml` first to fetch the document structure and block IDs.\n\n**[Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `docs_content:write`\n\n**[Granular Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `docs: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":"Insertblocksintoadocument","parameters":[{"name":"fileId","in":"path","description":"The document file ID.","required":true,"schema":{"type":"string","example":"p6zmDowpR_2h7isqK9zwBg"}}],"requestBody":{"content":{"application/json":{"schema":{"required":["blocks"],"type":"object","properties":{"positioning":{"type":"object","properties":{"above_block_id":{"type":"string","description":"Block ID to insert above (mutually exclusive with below)","example":"8d0ad8e130e14d44"},"below_block_id":{"type":"string","description":"Block ID to insert below (mutually exclusive with above)","example":"8d0ad8e130e14d44"},"parent_block_id":{"type":"string","description":"Parent block ID. Inserts at the end of this parent's children.","example":"a1b2c3d4e5f6"}},"description":"Block positioning options. At most one of `above_block_id`, `below_block_id`, or `parent_block_id` should be specified. If none are specified, blocks are appended to the end of the document."},"blocks":{"type":"string","description":"XML string containing block content. See the [Zoom Docs XML Format Specification](https://developers.zoom.us/docs/zoom-docs/doc-format-specification) for supported block types and syntax.","example":"<text>New content</text>"}}}}}},"responses":{"201":{"description":"Successfully inserted blocks."},"400":{"description":"**HTTP Status Code:** `400` <br>\n Bad Request  \n\n **Error Code:** `2000` <br>\n Block not found. <br>\n"},"403":{"description":"**HTTP Status Code:** `403` <br>\n Forbidden  \n\n "},"404":{"description":"**HTTP Status Code:** `404` <br>\n Not Found  \n\n **Error Code:** `4000` <br>\n File 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_authorization":[]}],"x-extensions":{"x-permissions":[],"x-macro-scopes":["docs_content:write"],"x-granular-scopes":["docs:write:content"]}}},"/docs/files/{fileId}/blocks/replace_range":{"post":{"tags":["Doc Content"],"summary":"Replace a range of blocks","description":"Replace a contiguous range of sibling blocks with new blocks in a single atomic operation. All blocks between start and end (inclusive) are removed and replaced with the provided XML block content. Important: `start_block_id` and `end_block_id` must be direct children of the same parent block (siblings). If they are not siblings, the operation will fail. Use the Get file content endpoint to verify the document structure before calling this endpoint.\n\n**[Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `docs_content:update`\n\n**[Granular Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `docs:update: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":"Replacearangeofblocks","parameters":[{"name":"fileId","in":"path","description":"The document file ID.","required":true,"schema":{"type":"string","example":"p6zmDowpR_2h7isqK9zwBg"}}],"requestBody":{"content":{"application/json":{"schema":{"required":["blocks","end_block_id","start_block_id"],"type":"object","properties":{"blocks":{"type":"string","description":"XML string containing block content. See the [Zoom Docs XML Format Specification](https://developers.zoom.us/docs/zoom-docs/doc-format-specification) for supported block types and syntax.","example":"<text>New content</text>"},"start_block_id":{"type":"string","description":"Block ID of the first block in the range.","example":"a1b2c"},"end_block_id":{"type":"string","description":"Block ID of the last block in the range.","example":"d4e5f"}}}}}},"responses":{"204":{"description":"Successfully replaced the specified block range with new blocks."},"400":{"description":"**HTTP Status Code:** `400` <br>\n Bad Request  \n\n **Error Code:** `2000` <br>\n Block not found. <br>\n"},"403":{"description":"**HTTP Status Code:** `403` <br>\n Forbidden  \n\n "},"404":{"description":"**HTTP Status Code:** `404` <br>\n Not Found  \n\n **Error Code:** `4000` <br>\n File 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_authorization":[]}],"x-extensions":{"x-permissions":[],"x-macro-scopes":["docs_content:update"],"x-granular-scopes":["docs:update:content"]}}},"/docs/files/{fileId}/blocks/{blockId}":{"delete":{"tags":["Doc Content"],"summary":"Delete a specific block","description":"Deletes a block and all its content from the document.\n\n**[Granular Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `docs: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":"DeleteBlock","parameters":[{"name":"fileId","in":"path","description":"The doc file ID containing the block to delete.","required":true,"schema":{"type":"string","example":"p6zmDowpR_2h7isqK9zwBg"}},{"name":"blockId","in":"path","description":"The unique identifier of the block to delete.","required":true,"schema":{"type":"string","example":"8d0ad8e130e14d44adae4f78303fc6cc"}}],"responses":{"204":{"description":"Successfully deleted the block."},"400":{"description":"**HTTP Status Code:** `400` <br>\n Bad Request  \n\n **Error Code:** `2000` <br>\n Block not found. <br>\n"},"403":{"description":"**HTTP Status Code:** `403` <br>\n Forbidden  \n\n "},"404":{"description":"**HTTP Status Code:** `404` <br>\n Not Found  \n\n **Error Code:** `4000` <br>\n File 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_authorization":[]}],"x-extensions":{"x-permissions":[],"x-granular-scopes":["docs:delete:content"]}},"patch":{"tags":["Doc Content"],"summary":"Update a specific block","description":"Updates the content of an existing block using XML-formatted content. Keeps the existing block type and replaces the content. To change the block type, use ReplaceBlockRange.\n\n**[Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `docs_content:update`\n\n**[Granular Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `docs:update: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":"UpdateBlock","parameters":[{"name":"fileId","in":"path","description":"The doc file ID.","required":true,"schema":{"type":"string","example":"p6zmDowpR_2h7isqK9zwBg"}},{"name":"blockId","in":"path","description":"The unique identifier of the block to update.","required":true,"schema":{"type":"string","example":"8d0ad8e130e14d44adae4f78303fc6cc"}}],"requestBody":{"content":{"application/json":{"schema":{"required":["block"],"type":"object","properties":{"block":{"type":"string","description":"A single XML block string with the updated content. See the [Zoom Docs XML Format Specification](https://developers.zoom.us/docs/zoom-docs/doc-format-specification) for supported block types and syntax.","example":"<text>New content</text>"}}}}}},"responses":{"204":{"description":"Block updated successfully."},"400":{"description":"**HTTP Status Code:** `400` <br>\n Bad Request  \n\n **Error Code:** `2000` <br>\n Block not found. <br>\n"},"403":{"description":"**HTTP Status Code:** `403` <br>\n Forbidden  \n\n "},"404":{"description":"**HTTP Status Code:** `404` <br>\n Not Found  \n\n **Error Code:** `4000` <br>\n File 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_authorization":[]}],"x-extensions":{"x-permissions":[],"x-macro-scopes":["docs_content:update"],"x-granular-scopes":["docs:update:content"]}}},"/docs/exports":{"post":{"tags":["Export"],"summary":"Create a file export","description":"Creates a export for specified file.\n\n**[Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `docs_export:write`,`docs_export:write:admin`\n\n**[Granular Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `docs:write:export`,`docs:write:export: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":"Createafileexport","requestBody":{"content":{"application/json":{"schema":{"required":["export_format","file_id"],"type":"object","properties":{"file_id":{"type":"string","description":"The doc file ID.","example":"ADuV705lSXW4c6fBgQFarQ"},"export_format":{"type":"string","description":"The target format for export.\n\nDifferent file types support different export formats:\n\n- `doc` supports export to `docx`, `markdown` or `pdf`\n- `data_table` supports export to `csv`","example":"docx","enum":["docx","markdown","pdf","csv"]}}}}}},"responses":{"201":{"description":"A Docs file is being converted into expected format.","content":{"application/json":{"schema":{"required":["export_id"],"type":"object","properties":{"export_id":{"type":"string","description":"The unique ID for your export. Use this ID to check the export status via the Get file export status endpoint (GET /docs/exports/{exportId}/status).","example":"ccbb4d8f72774741af8b8141f92e6d83"}}}}}},"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_authorization":[]}],"x-extensions":{"x-permissions":["DocsContent:Read"],"x-macro-scopes":["docs_export:write","docs_export:write:admin"],"x-granular-scopes":["docs:write:export","docs:write:export:admin"]}}},"/docs/exports/{exportId}/status":{"get":{"tags":["Export"],"summary":"Get file export status","description":"Use this API to query the status of a file export. \n\nBefore using this API, confirm that you have invoked the API Create a file export endpoint and obtained the `export_id`.\n\n**[Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `docs_export:read`,`docs_export:read:admin`\n\n**[Granular Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `docs:read:export`,`docs:read:export: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":"Getfileexportstatus","parameters":[{"name":"exportId","in":"path","description":"The unique ID for your export.","required":true,"schema":{"type":"string","example":"ccbb4d8f72774741af8b8141f92e6d83"}}],"responses":{"200":{"description":"Retrieves the docs file export result.","content":{"application/json":{"schema":{"required":["status"],"type":"object","properties":{"status":{"type":"string","description":"The status of the file export.\n\nEnum:\n- `processing` - The Docs file is being converted.\n- `succeeded` - The Docs file has been converted successfully.\n- `failed` - The Docs file has failed to convert.","example":"processing","enum":["processing","failed","succeeded"]},"download_link":{"type":"string","description":"The download link for the converted file. This field will be returned when the value of status is `succeeded`.","example":"https://file.zoom.us/file/xxxx?signature=xxxxx&token=xxxxx"},"expires_at":{"type":"string","description":"The expiration date of the `download_link` URL; after this time, the `download_link` will become invalid.\n\nThis field will be returned when the value of status is `succeeded`.","example":"2025-12-11T08:51:54.887212742Z"}}}}}},"400":{"description":"**HTTP Status Code:** `400` <br>\n Bad Request  \n\n **Error Code:** `5150` <br>\n Export file size limit exceeded. <br>\n"},"404":{"description":"**HTTP Status Code:** `404` <br>\n Not Found  \n\n **Error Code:** `5003` <br>\n The exportId not exists or expired. <br>\n"}},"security":[{"openapi_authorization":[]}],"x-extensions":{"x-permissions":["DocsContent:Read"],"x-macro-scopes":["docs_export:read","docs_export:read:admin"],"x-granular-scopes":["docs:read:export","docs:read:export:admin"]}}},"/docs/files/{fileId}/content":{"get":{"tags":["Export"],"summary":"Get file content","description":"Retrieves the file name and full file content in Markdown format.\n\n**[Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `docs_export:read`\n\n**[Granular Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `docs:read:export`\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":"Getfilecontent","parameters":[{"name":"fileId","in":"path","description":"The unique identifier of the document file.","required":true,"schema":{"type":"string","example":"ADuV705lSXW4c6fBgQFarQ"}}],"responses":{"200":{"description":"Retrieves the file name and full file content in Markdown format.","content":{"application/json":{"schema":{"type":"object","properties":{"file_name":{"type":"string","description":"The name of the document file.","example":"Q3 Plan"},"file_content":{"type":"string","description":"The document file content in Markdown format.","example":"## Product Development\n\n- Complete beta testing for mobile app by July 15\n- Implement AI-powered recommendation engine"}}}}}},"400":{"description":"**HTTP Status Code:** `400` <br>\n Bad Request  \n\n **Error Code:** `5150` <br>\n Export file size limit exceeded. <br>\n"},"403":{"description":"**HTTP Status Code:** `403` <br>\n Forbidden  Permission denied. \n\n "},"404":{"description":"**HTTP Status Code:** `404` <br>\n Not Found  File not found or deleted. \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_authorization":[]}],"x-extensions":{"x-permissions":[],"x-macro-scopes":["docs_export:read"],"x-granular-scopes":["docs:read:export"]}}},"/docs/files":{"post":{"tags":["File Management"],"summary":"Create a new file","description":"Creates a new file for a user.\n\n**[Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `docs:write`,`docs:write:admin`\n\n**[Granular Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `docs:write:file`,`docs:write:file:admin`\n\n**[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `MEDIUM`\n\n**Not supported in Gov cluster** ","operationId":"CreateDoc","requestBody":{"content":{"application/json":{"schema":{"type":"object","properties":{"file_name":{"type":"string","description":"The file name.","example":"Q3 Plan","default":"Untitled"},"parent_id":{"type":"string","description":"The ID of the parent file. The newly created file will become a child of this parent. If this parameter is omitted, the file will be placed under \"My Docs.\" Use \"root\" to represent the top-level folder of the current user. Folders can only be created under \"My Docs,\" a shared folder, or another folder.","example":"fIdgryoPSZ-Jm34Ag-OX7A"},"file_type":{"type":"string","description":"The type of a file.","example":"doc","default":"doc","enum":["doc","folder","data_table"]},"user_id":{"type":"string","description":"When invoked with the `admin` scope, this operation runs on behalf of the specified user. Permissions are validated against that user. This parameter is required with the `admin` scope and has no effect otherwise.","example":"9BGgfjrQTayGWw_422j1Bw"},"data_table":{"type":"object","properties":{"columns":{"type":"array","description":"The `columns` parameter is ignored when `file_type` is not `data_table`. When `file_type` is `data_table`, users can provide custom columns. If none are provided, three default columns—`text`, `people`, and `single_select`—along with a grid view will be created.","items":{"required":["column_type","name"],"type":"object","properties":{"name":{"type":"string","description":"The column name.","example":"Text"},"column_type":{"type":"string","description":"The type of the column.","example":"text","enum":["text","number","percent","single_select","multiple_select","date","people","checkbox","attachment","reaction","created_by","updated_by","created_time","updated_time","currency","page","url"]},"description":{"type":"string","description":"Column Description","example":"Text Content"},"column_options":{"type":"object","properties":{"date_option":{"title":"date_option","required":["format","is_24_hour_format"],"type":"object","properties":{"format":{"type":"string","description":"The date display format. Examples are as follows:\n2025-10-21 12:00\n2025/10/21 12:00\n2025/10/21 00:00\n25-10-21 00:30\n10/21/2025 00:30\n10/21/25 00:30\n08/10/2025 01:00\n08/10/25 01:00","example":"MM/dd/yyyy","enum":["MM/dd/yyyy","MM/dd/yy","M/d/yyyy","yy-MM-dd","yyyy/MM/dd","yy/MM/dd","yyyy/M/d","yy/M/d","dd/MM/yyyy","dd/MM/yy","MMM d, yyyy","EEE, MMM d","EEE, MMM d, yyyy","EEE"]},"is_24_hour_format":{"type":"boolean","description":"If `true`, display in 24-hour format. If `false`, display in 12-hour format.","example":false}},"description":"The `date`|`created_time`|`updated_time` column option."},"number_option":{"title":"number_option","required":["decimal","show_separator"],"type":"object","properties":{"decimal":{"type":"integer","description":"The number of decimal places.","example":1,"enum":[0,1,2,3,4,5]},"show_separator":{"type":"boolean","description":"If `true`, display thousand separators. If `false`, do not display thousand separators.","example":false}},"description":"The `number` column option."},"select_option":{"title":"select_option","type":"object","properties":{"options":{"type":"array","description":"The option list.","items":{"type":"object","properties":{"name":{"type":"string","description":"The option name.","example":"Blue"}},"description":"A specific option."}}},"description":"The `single_select` and `multiple_select` column option."},"percent_option":{"title":"percent_option","required":["decimal","show_progress_bar"],"type":"object","properties":{"decimal":{"type":"integer","description":"The number of decimal places.","example":1,"enum":[0,1,2,3,4,5]},"show_progress_bar":{"type":"boolean","description":"If `true`, display the progress bar. If `false`, do not display the progress bar.","example":false}},"description":"The `percent` column option."},"people_option":{"title":"people_option","required":["is_multiple","is_notify"],"type":"object","properties":{"is_multiple":{"type":"boolean","description":"If `true`, allow selection of multiple people. If `false`, only one person can be selected.","example":false},"is_notify":{"type":"boolean","description":"If `true`, send a notification message after selecting someone. If `false`, do not send a notification message after selecting someone.","example":false}},"description":"The `people` column option."},"reaction_option":{"title":"reaction_option","required":["allow_commenter_react","display_type","icon"],"type":"object","properties":{"icon":{"required":["type","value"],"type":"object","properties":{"type":{"type":"string","description":"The icon display type. Currently only supports emoji.","example":"emoji","enum":["emoji"]},"value":{"type":"string","description":"The icon value.","example":"👍","enum":["👍","👎","🌟"]}},"description":"The icon content."},"display_type":{"type":"string","description":"The reaction icon display type.","example":"number","enum":["number","people","none"]},"allow_commenter_react":{"type":"boolean","description":"Whether a user with only commenter permission is allowed to click. If `true`, the user is allowed to click. If `false`, the user is not allowed to click.","example":false}},"description":"The `reaction` column option."},"currency_option":{"title":"currency_option","required":["decimal","format","symbol"],"type":"object","properties":{"decimal":{"type":"integer","description":"The number of decimal places.","example":1,"enum":[0,1,2,3,4,5]},"symbol":{"type":"string","description":"The currency symbol.","example":"$","enum":["$","¥","€","Ft","Rp","kr","R","CHF","DH","₹","zł","₽","₩","฿","₺","£"]},"format":{"type":"string","description":"The currency format.","example":"accounting","enum":["accounting","currency"]}},"description":"The `currency` column option."},"attachment_option":{"title":"attachment_option","required":["layout"],"type":"object","properties":{"layout":{"type":"string","description":"The attachment layout.","example":"thumbnail","enum":["thumbnail","full_width"]}},"description":"The `attachment` column option."},"url_option":{"title":"url_option","required":["display_type","open_type"],"type":"object","properties":{"display_type":{"type":"string","description":"The URL display type.","example":"title","enum":["title","full","icon"]},"open_type":{"type":"string","description":"The URL open type.","example":"current_page","enum":["current_page","new_page"]}},"description":"The `url` column option."}},"description":"The corresponding relationship between column type and column option is as follows:\n\n`date`|`created_time`|`updated_time`: date_option\n`number`: number_option\n`currency`: currency_option\n`percent`: percent_option\n`url`: url_option\n`attachment`: attachment_option\n`reaction`: reaction_option\n`single_select`|`multiple_select`: select_option\n`people`: people_option\n\nOther column types do not have a column option."}}}}},"description":"The data table schema information."}},"description":"Create a new file request body."}}}},"responses":{"201":{"description":"Returns the ID of the created file.","content":{"application/json":{"schema":{"type":"object","properties":{"file_id":{"type":"string","description":"The ID of a file in Docs.","example":"ADuV705lSXW4c6fBgQFarQ"}}}}}},"400":{"description":"**HTTP Status Code:** `400` <br>\n Bad Request  Invalid request parameters provided. \n\n "},"403":{"description":"**HTTP Status Code:** `403` <br>\n Forbidden  Permission required to create files under this parent directory. \n\n "},"404":{"description":"**HTTP Status Code:** `404` <br>\n Not Found  File 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_authorization":[]}],"x-extensions":{"x-permissions":["DocsMgt:Edit"],"x-macro-scopes":["docs:write","docs:write:admin"],"x-granular-scopes":["docs:write:file","docs:write:file:admin"]}}},"/docs/files/{fileId}":{"get":{"tags":["File Management"],"summary":"Get metadata of a file","description":"Get metadata of a file.\n\n**[Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `docs:read`,`docs:read:admin`\n\n**[Granular Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `docs:read:file`,`docs:read:file: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":"QueryFileMetadata","parameters":[{"name":"fileId","in":"path","description":"The doc file ID.","required":true,"schema":{"type":"string","example":"ADuV705lSXW4c6fBgQFarQ"}}],"responses":{"200":{"description":"Returns the basic metadata of this file.","content":{"application/json":{"schema":{"required":["created_time","file_id","file_link","file_name","file_type","modified_time"],"type":"object","properties":{"file_id":{"type":"string","description":"The doc file ID.","example":"ADuV705lSXW4c6fBgQFarQ"},"file_name":{"type":"string","description":"The doc file name.","example":"Q3 Plan"},"file_type":{"type":"string","description":"The type of a file.","example":"doc","default":"doc","enum":["doc","folder","data_table"]},"file_link":{"type":"string","description":"The URL link of the file.","example":"https://docs.zoom.us/doc/ADuV705lSXW4c6fBgQFarQ"},"created_time":{"type":"string","description":"The time when the file created.","example":"2025-06-30T09:47:40.249Z"},"modified_time":{"type":"string","description":"The time when the file last modified.","example":"2025-06-30T09:47:40.249Z"},"file_icon":{"description":"The file icon. Built-in icons use the `icon` and `color` fields. Emoji icons use the `emoji` field. Icons cannot currently be set or retrieved for shared folders through the OpenAPI.","discriminator":{"propertyName":"type"},"oneOf":[{"required":["color","icon","type"],"type":"object","properties":{"type":{"type":"string","description":"The icon type.","example":"built-in","enum":["built-in"]},"icon":{"type":"string","description":"The built-in icon identifier.","example":"rocket","enum":["face","badge","crown","heart","ball","trophy","puzzle","star","calendar","rocket","message","phone","pill","car","book","tag","popcorn","screen","controller","tea","cake","gift","bug","key","bulb","baseball","cat","palette","globe","basketball","clubs","ghost","moon","cloth","camera","spades","credit_card","dog","blink","bell","dice","hammer","house","street_sign","like","doc","page","database","folder"]},"color":{"type":"string","description":"The color for a built-in icon.","example":"blue","enum":["blue","red","orange","yellow","green","pink","purple","emerald","sky","stone"]}},"additionalProperties":false,"description":"A built-in icon."},{"required":["emoji","type"],"type":"object","properties":{"type":{"type":"string","description":"The icon type.","example":"emoji","enum":["emoji"]},"emoji":{"type":"string","description":"The Unicode emoji character or emoji sequence.","example":"😀"}},"additionalProperties":false,"description":"An emoji icon."},{"required":["type"],"type":"object","properties":{"type":{"type":"string","description":"The icon type.","example":"none","enum":["none"]}},"additionalProperties":false,"description":"No icon. When provided in an update request, removes the existing icon. When returned in a response, indicates that no icon is set."}]}}}}}},"400":{"description":"**HTTP Status Code:** `400` <br>\n Bad Request  \n\n "},"403":{"description":"**HTTP Status Code:** `403` <br>\n Forbidden  Permission Denied. \n\n "},"404":{"description":"**HTTP Status Code:** `404` <br>\n Not Found  File Not Found/Deleted. \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_authorization":[]}],"x-extensions":{"x-permissions":["DocsMgt:Read"],"x-macro-scopes":["docs:read","docs:read:admin"],"x-granular-scopes":["docs:read:file","docs:read:file:admin"]}},"delete":{"tags":["File Management"],"summary":"Delete a file","description":"Delete a file.\n\n**[Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `docs:delete`,`docs:delete:admin`\n\n**[Granular Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `docs:delete:file`,`docs:delete:file:admin`\n\n**[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `MEDIUM`\n\n**Not supported in Gov cluster** ","operationId":"DeleteFile","parameters":[{"name":"fileId","in":"path","description":"The doc file ID.","required":true,"schema":{"type":"string","example":"ADuV705lSXW4c6fBgQFarQ"}}],"responses":{"204":{"description":"**HTTP Status Code**: `204`   \n \nFile deleted successfully."},"400":{"description":"**HTTP Status Code:** `400` <br>\n Bad Request  \n\n "},"403":{"description":"**HTTP Status Code:** `403` <br>\n Forbidden  Permission Denied. \n\n "},"404":{"description":"**HTTP Status Code:** `404` <br>\n Not Found  File Not Found/Deleted. \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_authorization":[]}],"x-extensions":{"x-permissions":["DocsMgt:Edit"],"x-macro-scopes":["docs:delete","docs:delete:admin"],"x-granular-scopes":["docs:delete:file","docs:delete:file:admin"]}},"patch":{"tags":["File Management"],"summary":"Modify metadata of a file","description":"Modify metadata of a file.\n\n**[Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `docs:write`,`docs:write:admin`\n\n**[Granular Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `docs:update:file`,`docs:update:file:admin`\n\n**[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `MEDIUM`\n\n**Not supported in Gov cluster** ","operationId":"ModifyMetadata","parameters":[{"name":"fileId","in":"path","description":"The doc file ID.","required":true,"schema":{"type":"string","example":"ADuV705lSXW4c6fBgQFarQ"}}],"requestBody":{"content":{"application/json":{"schema":{"minProperties":1,"type":"object","properties":{"file_name":{"type":"string","description":"File title name.","example":"Q3 plan"},"file_icon":{"description":"The file icon. Built-in icons use the `icon` and `color` fields. Emoji icons use the `emoji` field. Icons cannot currently be set or retrieved for shared folders through the OpenAPI.","discriminator":{"propertyName":"type"},"oneOf":[{"required":["color","icon","type"],"type":"object","properties":{"type":{"type":"string","description":"The icon type.","example":"built-in","enum":["built-in"]},"icon":{"type":"string","description":"The built-in icon identifier.","example":"rocket","enum":["face","badge","crown","heart","ball","trophy","puzzle","star","calendar","rocket","message","phone","pill","car","book","tag","popcorn","screen","controller","tea","cake","gift","bug","key","bulb","baseball","cat","palette","globe","basketball","clubs","ghost","moon","cloth","camera","spades","credit_card","dog","blink","bell","dice","hammer","house","street_sign","like","doc","page","database","folder"]},"color":{"type":"string","description":"The color for a built-in icon.","example":"blue","enum":["blue","red","orange","yellow","green","pink","purple","emerald","sky","stone"]}},"additionalProperties":false,"description":"A built-in icon."},{"required":["emoji","type"],"type":"object","properties":{"type":{"type":"string","description":"The icon type.","example":"emoji","enum":["emoji"]},"emoji":{"type":"string","description":"The Unicode emoji character or emoji sequence.","example":"😀"}},"additionalProperties":false,"description":"An emoji icon."},{"required":["type"],"type":"object","properties":{"type":{"type":"string","description":"The icon type.","example":"none","enum":["none"]}},"additionalProperties":false,"description":"No icon. When provided in an update request, removes the existing icon. When returned in a response, indicates that no icon is set."}]}},"additionalProperties":false}}}},"responses":{"204":{"description":"**HTTP Status Code**: `204`   \n \nModify metadata successfully."},"400":{"description":"**HTTP Status Code:** `400` <br>\n Bad Request  \n\n "},"403":{"description":"**HTTP Status Code:** `403` <br>\n Forbidden  Permission Denied. \n\n "},"404":{"description":"**HTTP Status Code:** `404` <br>\n Not Found  File Not Found/Deleted. \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_authorization":[]}],"x-extensions":{"x-permissions":["DocsMgt:Edit"],"x-macro-scopes":["docs:write","docs:write:admin"],"x-granular-scopes":["docs:update:file","docs:update:file:admin"]}}},"/docs/files/{fileId}/children":{"get":{"tags":["File Management"],"summary":"List all children of a file","description":"List all children of a file.\n\n**[Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `docs:read`,`docs:read:admin`\n\n**[Granular Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `docs:read:list_children`,`docs:read:list_children:admin`\n\n**[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `MEDIUM`","operationId":"ListAllChildren","parameters":[{"name":"fileId","in":"path","description":"The fileId of a file. When querying children of 'My docs', `fileId` should be `root`.","required":true,"schema":{"type":"string","example":"61kkJE-rR52UsywN25E0hQ"}},{"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":"eyJ0aW1lQ3Vyc29yIjoiMjAyNS0wNC0yMVQwOTo0NTo1OC45NTJaIiwiaWRDdXJzb3IiOiJzemFsMkpmTlFteTExY1JwdkYxRWhBIn0="}},{"name":"page_size","in":"query","description":"The number of shared folders to query. The maximum size is 50.","required":false,"schema":{"maximum":50,"minimum":1,"type":"integer","example":10,"default":10}}],"responses":{"200":{"description":"Returns all children files.","content":{"application/json":{"schema":{"required":["files","next_page_token"],"type":"object","properties":{"files":{"maxItems":50,"type":"array","description":"children list","items":{"required":["created_time","file_id","file_link","file_name","file_type","modified_time"],"type":"object","properties":{"file_id":{"type":"string","description":"The ID of a file.","example":"61kkJE-rR52UsywN25E0hQ"},"file_name":{"type":"string","description":"The name of a file.","example":"Q3 plan"},"file_type":{"type":"string","description":"The type of a file","example":"doc","default":"doc","enum":["doc","folder","data_table"]},"file_link":{"type":"string","description":"The access link of a file.","example":"https://docs.zoom.us/doc/61kkJE-rR52UsywN25E0hQ"},"created_time":{"type":"string","description":"The time when the file created.","example":"2025-06-30T09:47:40.249Z"},"modified_time":{"type":"string","description":"The time when the file last modified.","example":"2025-06-30T09:47:40.249Z"}},"description":"child item"}},"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.","example":"eyJ0aW1lQ3Vyc29yIjoiMjAyNS0wNC0yMVQwOTo0NTo1OC45NTJaIiwiaWRDdXJzb3IiOiJzemFsMkpmTlFteTExY1JwdkYxRWhBIn0="}}}}}},"400":{"description":"**HTTP Status Code:** `400` <br>\n Bad Request  \n\n "},"403":{"description":"**HTTP Status Code:** `403` <br>\n Forbidden  Permission Denied. \n\n "},"404":{"description":"**HTTP Status Code:** `404` <br>\n Not Found  Parent 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_authorization":[]}],"x-extensions":{"x-permissions":["DocsMgt:Read"],"x-macro-scopes":["docs:read","docs:read:admin"],"x-granular-scopes":["docs:read:list_children","docs:read:list_children:admin"]}}},"/docs/files/{fileId}/owner":{"put":{"tags":["File Management"],"summary":"Transfer ownership of a file","description":"Transfer a file’s ownership to another user. \nOnly `doc` or `data table` files are supported. \nOnly the file `owner` has permission to perform an ownership transfer.\n\n**[Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `docs_file_owner:write`,`docs_file_owner:write:admin`\n\n**[Granular Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `docs:update:file_owner`,`docs:update:file_owner:admin`\n\n**[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `MEDIUM`\n\n**Not supported in Gov cluster** ","operationId":"TransferOwnershipOfAFile","parameters":[{"name":"fileId","in":"path","description":"The ID of a file in docs.","required":true,"schema":{"type":"string","example":"_4oHCpleRgGumHa60amdKl"}}],"requestBody":{"content":{"application/json":{"schema":{"required":["user_id"],"type":"object","properties":{"user_id":{"type":"string","description":"Zoom user ID of the new owner.","example":"9aSWJV2rTyWwkIDWmPYsfg"}}}}}},"responses":{"204":{"description":"Nothing to return."},"403":{"description":"**HTTP Status Code:** `403` <br>\n Forbidden  Permission denied \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_authorization":[]}],"x-extensions":{"x-permissions":["DocsMgt:Edit"],"x-macro-scopes":["docs_file_owner:write","docs_file_owner:write:admin"],"x-granular-scopes":["docs:update:file_owner","docs:update:file_owner:admin"]}}},"/docs/users/{userId}/root":{"get":{"tags":["File Management"],"summary":"Get user My docs info","description":"Get the specified user's My docs info. My docs is the root of a user's documents.\n\n**Example**:\n\nWhen an admin needs to list all children of another user's My docs ([/docs/files/{fileId}/children](https://s.zoom.us/u/bPFf2TRxP)), this API should be called to get the target user's My docs ID as `fileId` in path.\n\n**[Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `docs:read:admin`\n\n**[Granular Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `docs:read:file: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":"GetUserMyDocsID","parameters":[{"name":"userId","in":"path","description":"The ID of the user you want the root directory ID of.","required":true,"schema":{"type":"string","example":"aCdqwwghR16QF4dDe1Ex_A"}}],"responses":{"200":{"description":"Returns user My Docs info.","content":{"application/json":{"schema":{"required":["root_id"],"type":"object","properties":{"root_id":{"type":"string","description":"User My Docs ID.","example":"dAdqGeghRh6QF4dDe1Ex_A"}}}}}},"400":{"description":"**HTTP Status Code:** `400` <br>\n Bad Request  \n\n "},"404":{"description":"**HTTP Status Code:** `404` <br>\n Not Found  user id 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_authorization":[]}],"x-extensions":{"x-permissions":["DocsMgt:Read"],"x-macro-scopes":["docs:read:admin"],"x-granular-scopes":["docs:read:file:admin"]}}},"/docs/file_uploads":{"post":{"tags":["File Uploads"],"summary":"Create file upload for docs import or attachments","description":"Create a file upload for document import or attachments.\n\nNotes:\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 retain the Authorization header when redirected to a different hostname.\n- Unsupported file formats: `.svg`.\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 Docs Management.\n\n**[Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `docs_file_uploads:write`,`docs_file_uploads:write:admin`\n\n**[Granular Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `docs:write:file_uploads`,`docs:write:file_uploads: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":"Uploadfilefordocsimportorattachments","requestBody":{"content":{"multipart/form-data":{"schema":{"required":["file"],"type":"object","properties":{"file":{"type":"string","description":"The data file to be uploaded.","example":"<binary data>"}}}}}},"responses":{"201":{"description":"File successfully created.","content":{"application/json":{"schema":{"type":"object","properties":{"file_upload_id":{"type":"string","description":"The unique ID of the file upload.","example":"aBvhhhyjQUal6HacwXlYwe"}}}}}},"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_authorization":[]}],"x-extensions":{"x-permissions":["DocsMgt:Edit"],"x-macro-scopes":["docs_file_uploads:write","docs_file_uploads:write:admin"],"x-granular-scopes":["docs:write:file_uploads","docs:write:file_uploads:admin"]}}},"/docs/files/{fileId}/general_access_setting":{"get":{"tags":["General Access"],"summary":"Get the general access setting of a file","description":"Get the general access settings of a file. Only `doc` or `data table` files are supported.\n\n**[Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `docs_general_access:read`,`docs_general_access:read:admin`\n\n**[Granular Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `docs:read:general_access`,`docs:read:general_access:admin`\n\n**[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `MEDIUM`","operationId":"GetFileGeneralAccess","parameters":[{"name":"fileId","in":"path","description":"The ID of a file in Docs.","required":true,"schema":{"type":"string","example":"_4oHCpleRgGumHa60amdKl"}}],"responses":{"200":{"description":"Return the general access setting of a file.","content":{"application/json":{"schema":{"type":"object","properties":{"general_access_setting":{"required":["share_scope"],"type":"object","properties":{"share_scope":{"type":"string","description":"The general access scope of this file.\n`collaborators_only`: only collaborators of this file can access\n`anyone_in_org`: users within the same orgnization as the file owner can access\n`anyone_with_link`: anyone can access this file, including anonymous user.","example":"anyone_in_org","enum":["collaborators_only","anyone_in_org","anyone_with_link"]},"role":{"type":"string","description":"Role to collaborate. This field is empty when `share_scope` is set to `collaborators_only`.","example":"viewer","enum":["viewer","commenter","editor"]}},"description":"The general access setting of this file."}}}}}},"400":{"description":"**HTTP Status Code:** `400` <br>\n Bad Request  \n\n "},"403":{"description":"**HTTP Status Code:** `403` <br>\n Forbidden  Permission Denied. \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_authorization":[]}],"x-extensions":{"x-permissions":["DocsMgt:Read"],"x-macro-scopes":["docs_general_access:read","docs_general_access:read:admin"],"x-granular-scopes":["docs:read:general_access","docs:read:general_access:admin"]}},"patch":{"tags":["General Access"],"summary":"Modify the general access setting of a file","description":"Modify the general access setting for a file. Only `doc` or `data table` files are supported.\n\n**[Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `docs_general_access:write`,`docs_general_access:write:admin`\n\n**[Granular Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `docs:update:general_access`,`docs:update:general_access:admin`\n\n**[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `MEDIUM`\n\n**Not supported in Gov cluster** ","operationId":"ModifyFileGeneralAccess","parameters":[{"name":"fileId","in":"path","description":"The ID of a file in Docs.","required":true,"schema":{"type":"string","example":"amgFY09ZSJOrgROOkWG77A"}}],"requestBody":{"content":{"application/json":{"schema":{"required":["general_access_setting"],"type":"object","properties":{"general_access_setting":{"required":["share_scope"],"type":"object","properties":{"share_scope":{"type":"string","description":"The general access scope of this file.\n`collaborators_only`: only collaborators of this file can access\n`anyone_in_org`: users within the same orgnization as the file owner can access\n`anyone_with_link`: anyone can access this file, including anonymous user.","example":"anyone_in_org","enum":["collaborators_only","anyone_in_org","anyone_with_link"]},"role":{"type":"string","description":"Role to collaborate. This field is empty when `share_scope` is set to `collaborators_only`.","example":"viewer","enum":["viewer","commenter","editor"]}},"description":"The general access setting."}}}}}},"responses":{"204":{"description":"Nothing to return."},"400":{"description":"**HTTP Status Code:** `400` <br>\n Bad Request  \n\n "},"403":{"description":"**HTTP Status Code:** `403` <br>\n Forbidden  Permission Denied. \n\n "},"404":{"description":"**HTTP Status Code:** `404` <br>\n Not Found  File 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_authorization":[]}],"x-extensions":{"x-permissions":["DocsMgt:Edit"],"x-macro-scopes":["docs_general_access:write","docs_general_access:write:admin"],"x-granular-scopes":["docs:update:general_access","docs:update:general_access:admin"]}}},"/docs/import_content":{"post":{"tags":["Import"],"summary":"Create a new file from content","description":"Creates a new doc from Markdown content.\n\nThe Markdown content is limited to 100 KB in size.\n\n**[Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `docs_import:write`\n\n**[Granular Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `docs:write:import`\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":"createNewFileWithMarkdown","requestBody":{"content":{"application/json":{"schema":{"type":"object","properties":{"file_name":{"type":"string","description":"The name of the file.","example":"Q3 Plan"},"parent_id":{"type":"string","description":"The ID of the parent file. The newly created file will become a child of this parent. If this parameter is omitted, the file will be placed under **My Docs**. Use `root` to represent the top-level folder of the current user. Folders can only be created under **My Docs**, a shared folder, or another folder.","example":"fIdgryoPSZ-Jm34Ag-OX7A"},"content":{"type":"string","description":"The Markdown-formatted content. If the content is empty, an empty document will be created.","example":"# Project Overview  This document provides a concise outline for a sample project, including goals, milestones, tasks, and open questions.  ## 1. Goals  - Define the project scope clearly. - Deliver a working prototype by the target date. - Ensure documentation is complete and maintainable.  ## 2. Milestones  | Milestone | Description | Target Date | |----------|-------------|--------------| | M1 | Requirement gathering | 2025-01-15 | | M2 | Prototype ready | 2025-02-10 | | M3 | Final review | 2025-03-01 |  ## 3. Tasks  - [ ] Set up development environment   - [ ] Draft technical design   - [ ] Implement core features   - [ ] Write unit tests   - [ ] Prepare demo  ## 4. Architecture Diagram (Mermaid)  ```mermaid flowchart TD     A[Client] --> B[API Gateway]     B --> C[Service A]     B --> D[Service B]     D --> E[Database] ```  ## 5. Open Questions  - Should we adopt a monorepo structure? - Which logging strategy is preferred? - How should we structure integration tests?  ## 6. Notes  Add any additional remarks or context here."}}}}}},"responses":{"201":{"description":"The uploaded file is being converted into a doc file.","content":{"application/json":{"schema":{"required":["file_id","file_link"],"type":"object","properties":{"file_id":{"type":"string","description":"The newly created file ID.","example":"ch4L4KKgQVesEJcqdt1qIw"},"file_link":{"type":"string","description":"The URL of the file.","example":"https://docs.zoom.us/doc/ch4L4KKgQVesEJcqdt1qIw"}}}}}},"400":{"description":"**HTTP Status Code:** `400` <br>\n Bad Request  \n\n **Error Code:** `5005` <br>\n Incorrect file format. <br>\n**Error Code:** `5109` <br>\n The size of content exceeds the limit. <br>\n**Error Code:** `5110` <br>\n The number of images exceeds the limit. <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_authorization":[]}],"x-extensions":{"x-permissions":[],"x-macro-scopes":["docs_import:write"],"x-granular-scopes":["docs:write:import"]}}},"/docs/imports":{"post":{"tags":["Import"],"summary":"Create a new file by import","description":"Creates a new file from a file upload.\n\n**When importing the uploaded file as a specified type of Docs file:**\n- `doc`\n  - Upload file size limit is 10MB.\n  - The size limit for a single Block's content is 1MB.\n  - Maximum number of Blocks allowed is 20,000.\n- `data_table`\n  - Upload file size limit is 10MB.\n  - Maximum number of columns allowed in a single data table is 200.\n  - The size limit for a single Block's content is 1MB.\n  - Maximum number of Blocks allowed in a single data table is 20,000.\n\n**When importing an HTML compressed package exported from Notion into Docs:**\n  - Maximum allowed size for a single zip archive is 4GB.\n  - Maximum number of files that can be imported into Docs within a single ZIP file is 100,000.\n  - The maximum depth of parent-child relationships between files in the tree structure is 20.\n  - Maximum number of child nodes allowed per node in the tree is 2,000.\n\n\n\n**[Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `docs_import:write`,`docs_import:write:admin`\n\n**[Granular Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `docs:write:import`,`docs: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":"Createanewfilebyimport","requestBody":{"content":{"application/json":{"schema":{"required":["file_upload_id","file_upload_type"],"type":"object","properties":{"file_name":{"type":"string","description":"The name of the file.","example":"Q3 Plan"},"file_type":{"type":"string","description":"The type of the file created after import.","example":"doc","default":"doc","enum":["doc","data_table"]},"parent_id":{"type":"string","description":"The ID of the parent file. The newly created file will become a child of this parent. If this parameter is omitted, the file will be placed under **My Docs**. Use `root` to represent the top-level folder of the current user. Folders can only be created under **My Docs**, a shared folder, or another folder.","example":"fIdgryoPSZ-Jm34Ag-OX7A"},"file_upload_id":{"type":"string","description":"The ID of the file upload. Ensure the file is valid, within the size limit, and in a supported format.","example":"aBvhhhyjQUal6HacwXlYwe"},"file_upload_type":{"type":"string","description":"The supported file format for upload. For file type `doc`, the supported formats are `.docx`, `.txt`, `.html` and `.md`. For file type `data_table`, the supported formats are `.xlsx` and `.csv`. For the zip file in HTML format exported from Notion, use `notion_zip`.","example":"docx","enum":["docx","txt","markdown","csv","xlsx","notion_zip","html"]},"user_id":{"type":"string","description":"When invoked with the `admin` scope, this operation runs on behalf of the specified user. Permissions are validated against that user. This parameter is required with the `admin` scope and has no effect otherwise.","example":"9BGgfjrQTayGWw_422j1Bw"}}}}}},"responses":{"201":{"description":"The uploaded file is being converted into a Docs file.","content":{"application/json":{"schema":{"required":["import_id"],"type":"object","properties":{"import_id":{"type":"string","description":"The unique ID for your import. Use this ID to check the import status via the **Get file import status** endpoint (GET /docs/imports/{importId}/status).","example":"ccbb4d8f72774741af8b8141f92e6d83"}}}}}},"400":{"description":"**HTTP Status Code:** `400` <br>\n Bad Request  \n\n **Error Code:** `5004` <br>\n File size limit exceeded. <br>\n**Error Code:** `5005` <br>\n Incorrect file format. <br>\n**Error Code:** `20001` <br>\n Invalid `user_id` for `admin` scope. <br>\n**Error Code:** `20002` <br>\n `parent_id` file not found. <br>\n**Error Code:** `20003` <br>\n Invalid `file_type`. <br>\n"},"403":{"description":"**HTTP Status Code:** `403` <br>\n Forbidden  Permission is needed to create children under this file. \n\n "},"404":{"description":"**HTTP Status Code:** `404` <br>\n Not Found  \n\n **Error Code:** `5007` <br>\n File upload does not exist. <br>\n"}},"security":[{"openapi_authorization":[]}],"x-extensions":{"x-permissions":["DocsMgt:Edit"],"x-macro-scopes":["docs_import:write","docs_import:write:admin"],"x-granular-scopes":["docs:write:import","docs:write:import:admin"]}}},"/docs/imports/{importId}/status":{"get":{"tags":["Import"],"summary":"Get file import status","description":"Use this API to query the status of a new file by import. Before using this API, confirm that you have invoked the API **Create a new file by import** endpoint and obtained the `import_id`.\n\n**[Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `docs_import:read`,`docs_import:read:admin`\n\n**[Granular Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `docs:read:import`,`docs:read:import: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":"Getdocsfileimportstatus","parameters":[{"name":"importId","in":"path","description":"The unique ID for your import.","required":true,"schema":{"type":"string","example":"ccbb4d8f72774741af8b8141f92e6d83"}}],"responses":{"200":{"description":"Retrieves the docs file import result.","content":{"application/json":{"schema":{"required":["file_id","file_type","status"],"type":"object","properties":{"status":{"type":"string","description":"The status of the file created by importing an uploaded file.\n\nEnum:\n`processing` - The uploaded file is being converted.\n`succeeded` - The uploaded file has been converted successfully.\n`failed` - The uploaded file has failed to convert.","example":"processing","enum":["succeeded","processing","failed"]},"file_id":{"type":"string","description":"The file ID is `nullable`. This value is returned only when the status is `succeeded`.\n\nThe zip file in HTML format exported from Notion may contain data for one or more files; importing will only return the root ID of the imported files.","example":"ch4L4KKgQVesEJcqdt1qIw"},"file_type":{"type":"string","description":"The type of the created file.","example":"doc","enum":["doc","data_table"]}}}}}},"400":{"description":"**HTTP Status Code:** `400` <br>\n Bad Request  \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_authorization":[]}],"x-extensions":{"x-permissions":["DocsMgt:Edit"],"x-macro-scopes":["docs_import:read","docs_import:read:admin"],"x-granular-scopes":["docs:read:import","docs:read:import:admin"]}}},"/docs/reports/activity":{"get":{"tags":["Report"],"summary":"Get activity report","description":"Retrieve a list of docs activity logs. Only one month at a time can be requested and it must be within the last year.\n\n**[Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `docs_activity_report:read:admin`\n\n**[Granular Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `docs:read:activity_report:admin`\n\n**[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `MEDIUM`","operationId":"GetActivityReport","parameters":[{"name":"from","in":"query","description":"The start date in 'yyyy-MM-dd' format (UTC). The date range defined by the `from` and `to` parameters must not exceed one month.","required":true,"schema":{"type":"string","example":"2026-01-27"}},{"name":"to","in":"query","description":"The end date in 'yyyy-MM-dd' format (UTC). The date range defined by the `from` and `to` parameters must not exceed one month.","required":true,"schema":{"type":"string","example":"2026-02-27"}},{"name":"keywords","in":"query","description":"Search by file name, file link, or file ID.","required":false,"schema":{"type":"string","example":"XbGoj7lnTlCAAf7Qp1FryQ"}},{"name":"operator_email","in":"query","description":"Search by operator's email address.","required":false,"schema":{"type":"string","example":"user@example.com"}},{"name":"event_types","in":"query","description":"Filter by event types. To include multiple event types, separate them with commas. \n\nValid event types:\n`file_created` `file_viewed` `file_edited` `shared_folder_visibility_changed` `shared_folder_description_changed` `shared_folder_external_share_changed` `file_name_changed` `file_icon_changed` `file_owner_changed` `file_collaborator_added` `file_collaborator_deleted` `file_collaborator_changed` `file_general_access_changed` `file_copied` `file_exported` `file_moved_to_trash` `file_restored_from_trash` `file_permanently_deleted` `file_published` `file_unpublished` `file_moved` `file_attachment_downloaded` `file_attachment_previewed` `file_comment_created` `file_comment_changed` `file_comment_deleted`","required":false,"schema":{"type":"string","example":"file_created,file_viewed,file_edited"}},{"name":"file_types","in":"query","description":"Filter by file types. To include multiple file types, separate them with commas. \n\nValid file types:\n\n`doc`\n`data_table`\n`shared_folder`\n`folder`","required":false,"schema":{"type":"string","example":"doc,folder"}},{"name":"page_size","in":"query","description":"The number of records to be returned within a single API call.","required":false,"schema":{"maximum":100,"minimum":1,"type":"integer","example":20,"default":10}},{"name":"next_page_token","in":"query","description":"Use the next page token to paginate through large result sets.","required":false,"schema":{"type":"string","example":"b43YBRLJFg3V4vsSpxvGdKIGtNbxn9h9If2"}}],"responses":{"200":{"description":"Activity logs retrieved successfully.","content":{"application/json":{"schema":{"required":["activity_logs","next_page_token"],"type":"object","properties":{"activity_logs":{"type":"array","description":"A list of activity logs.","items":{"required":["event_id","event_time","event_type","operator","payload","source_ip"],"type":"object","properties":{"event_id":{"type":"string","description":"The unique identifier of the event.","example":"Kbqnqi7OR8-vrhlp4ymMdA"},"event_type":{"type":"string","description":"The type of event.","example":"file_created","enum":["file_created","file_viewed","file_edited","shared_folder_visibility_changed","shared_folder_description_changed","shared_folder_external_share_changed","file_name_changed","file_icon_changed","file_owner_changed","file_collaborator_added","file_collaborator_deleted","file_collaborator_changed","file_general_access_changed","file_copied","file_exported","file_moved_to_trash","file_restored_from_trash","file_permanently_deleted","file_published","file_unpublished","file_moved","file_attachment_downloaded","file_attachment_previewed","file_comment_created","file_comment_changed","file_comment_deleted"]},"event_time":{"type":"string","description":"The time of the event.","example":"2026-01-06T10:09:21.595Z"},"source_ip":{"type":"string","description":"Source IP address, which can be in either IPv4 or IPv6 format.","example":"192.168.1.1"},"operator":{"required":["account_id","user_email","user_id"],"type":"object","properties":{"user_id":{"type":"string","description":"Operator's Zoom user ID.\n\n**Note**: For operators outside the account, their `user_id` will be hidden.","example":"aCdqwwghR16QF4dDe1Ex_A"},"account_id":{"type":"string","description":"Operator's Zoom account ID.","example":"d3w1Tgsps6Sm2PbB4rmk1cPw"},"user_email":{"type":"string","description":"Operator's email address.","example":"user@example.com"}},"description":"Operator information."},"payload":{"description":"Event payload. Structure varies by event_type.","oneOf":[{"title":"file_created","type":"object","properties":{"file":{"type":"object","properties":{"file_id":{"type":"string","description":"File ID.","example":"XbGoj7lnTlCAAf7Qp1FryQ"},"account_id":{"type":"string","description":"Zoom account ID.","example":"d3w1Tgsps6Sm2PbB4rmk1cPw"},"file_type":{"type":"string","description":"File type.","example":"doc"},"file_name":{"type":"string","description":"File name.","example":"Q1 Planning Doc"},"product_id":{"type":"string","description":"Product ID associated with the file.","example":"docs"},"shortcut_original_file_type":{"type":"string","description":"Original type if file is shortcut.","example":"doc"}},"description":"Created file metadata."},"initial_general_access":{"type":"object","properties":{"share_scope":{"type":"string","description":"Initial share scope.","example":"anyone_in_org","enum":["collaborators_only","anyone_in_org","anyone_with_link"]},"role":{"type":"string","description":"Initial role.","example":"viewer","enum":["editor","viewer","commenter"]}},"description":"Initial general access settings."}},"description":"Triggered when a new file is created."},{"title":"file_viewed","type":"object","properties":{"file":{"type":"object","properties":{"file_id":{"type":"string","description":"File ID.","example":"XbGoj7lnTlCAAf7Qp1FryQ"},"account_id":{"type":"string","description":"Zoom account ID.","example":"d3w1Tgsps6Sm2PbB4rmk1cPw"},"file_type":{"type":"string","description":"File type.","example":"doc"},"file_name":{"type":"string","description":"File name.","example":"Q1 Planning Doc"},"product_id":{"type":"string","description":"Product ID.","example":"docs"},"shortcut_original_file_type":{"type":"string","description":"Original type if shortcut.","example":"doc"}},"description":"Viewed file metadata."}},"description":"Triggered when a file is viewed."},{"title":"file_edited","type":"object","properties":{"file":{"type":"object","properties":{"file_id":{"type":"string","description":"File ID.","example":"XbGoj7lnTlCAAf7Qp1FryQ"},"account_id":{"type":"string","description":"Zoom account ID.","example":"d3w1Tgsps6Sm2PbB4rmk1cPw"},"file_type":{"type":"string","description":"File type.","example":"doc"},"file_name":{"type":"string","description":"File name.","example":"Q1 Planning Doc"},"product_id":{"type":"string","description":"Product ID.","example":"docs"},"shortcut_original_file_type":{"type":"string","description":"Original type if shortcut.","example":"doc"}},"description":"Edited file metadata."}},"description":"Triggered when file content is edited."},{"title":"shared_folder_visibility_changed","type":"object","properties":{"file":{"type":"object","properties":{"file_id":{"type":"string","description":"Shared folder ID.","example":"sf_123456"},"account_id":{"type":"string","description":"Zoom account ID.","example":"d3w1Tgsps6Sm2PbB4rmk1cPw"},"file_type":{"type":"string","description":"File type.","example":"shared_folder"},"file_name":{"type":"string","description":"Shared folder name.","example":"Team Space"},"product_id":{"type":"string","description":"Product ID.","example":"docs"},"shortcut_original_file_type":{"type":"string","description":"Original type if shortcut.","example":"doc"}},"description":"Shared folder metadata."},"visibility":{"type":"string","description":"New visibility.","example":"open","enum":["open","private"]}},"description":"Triggered when shared folder visibility changes."},{"title":"shared_folder_description_changed","type":"object","properties":{"file":{"type":"object","properties":{"file_id":{"type":"string","description":"Shared folder ID.","example":"sf_123456"},"account_id":{"type":"string","description":"Zoom account ID.","example":"d3w1Tgsps6Sm2PbB4rmk1cPw"},"file_type":{"type":"string","description":"File type.","example":"shared_folder"},"file_name":{"type":"string","description":"Shared folder name.","example":"Team Space"},"product_id":{"type":"string","description":"Product ID.","example":"docs"},"shortcut_original_file_type":{"type":"string","description":"Original type if shortcut.","example":"doc"}},"description":"Shared folder metadata."},"old_description":{"type":"string","description":"Description before update.","example":"Old team docs"},"new_description":{"type":"string","description":"Description after update.","example":"Updated team docs"}},"description":"Triggered when shared folder description changes."},{"title":"shared_folder_external_share_changed","type":"object","properties":{"file":{"type":"object","properties":{"file_id":{"type":"string","description":"Shared folder ID.","example":"sf_123456"},"account_id":{"type":"string","description":"Zoom account ID.","example":"d3w1Tgsps6Sm2PbB4rmk1cPw"},"file_type":{"type":"string","description":"File type.","example":"shared_folder"},"file_name":{"type":"string","description":"Shared folder name.","example":"Team Space"},"product_id":{"type":"string","description":"Product ID.","example":"docs"},"shortcut_original_file_type":{"type":"string","description":"Original type if shortcut.","example":"doc"}},"description":"Shared folder metadata."},"external_share":{"type":"boolean","description":"Whether external sharing is enabled after update.","example":true}},"description":"Triggered when shared folder external share setting changes."},{"title":"file_name_changed","type":"object","properties":{"file":{"type":"object","properties":{"file_id":{"type":"string","description":"File ID.","example":"XbGoj7lnTlCAAf7Qp1FryQ"},"account_id":{"type":"string","description":"Zoom account ID.","example":"d3w1Tgsps6Sm2PbB4rmk1cPw"},"file_type":{"type":"string","description":"File type.","example":"doc"},"file_name":{"type":"string","description":"New file name.","example":"Q1 Planning Doc v2"},"product_id":{"type":"string","description":"Product ID.","example":"docs"},"shortcut_original_file_type":{"type":"string","description":"Original type if shortcut.","example":"doc"}},"description":"Renamed file metadata."},"old_file_name":{"type":"string","description":"Old file name.","example":"Q1 Planning Doc"}},"description":"Triggered when file name changes."},{"title":"file_icon_changed","type":"object","properties":{"file":{"type":"object","properties":{"file_id":{"type":"string","description":"File ID.","example":"XbGoj7lnTlCAAf7Qp1FryQ"},"account_id":{"type":"string","description":"Zoom account ID.","example":"d3w1Tgsps6Sm2PbB4rmk1cPw"},"file_type":{"type":"string","description":"File type.","example":"doc"},"file_name":{"type":"string","description":"File name.","example":"Brand Guide"},"product_id":{"type":"string","description":"Product ID.","example":"docs"},"shortcut_original_file_type":{"type":"string","description":"Original type if shortcut.","example":"doc"}},"description":"File metadata."},"old_icon":{"type":"string","description":"Old icon value.","example":"book"},"new_icon":{"type":"string","description":"New icon value.","example":"star"}},"description":"Triggered when file icon changes."},{"title":"file_owner_changed","type":"object","properties":{"file":{"type":"object","properties":{"file_id":{"type":"string","description":"File ID.","example":"XbGoj7lnTlCAAf7Qp1FryQ"},"account_id":{"type":"string","description":"Zoom account ID.","example":"d3w1Tgsps6Sm2PbB4rmk1cPw"},"file_type":{"type":"string","description":"File type.","example":"doc"},"file_name":{"type":"string","description":"File name.","example":"Handover Notes"},"product_id":{"type":"string","description":"Product ID.","example":"docs"},"shortcut_original_file_type":{"type":"string","description":"Original type if shortcut.","example":"doc"}},"description":"Transferred file metadata."},"old_owner_info":{"type":"object","properties":{"user_id":{"type":"string","description":"Old owner user ID.","example":"aCdqwwghR16QF4dDe1Ex_A"},"user_email":{"type":"string","description":"Old owner email.","example":"old-owner@example.com"},"account_id":{"type":"string","description":"Old owner account ID if available.","example":"d3w1Tgsps6Sm2PbB4rmk1cPw"}},"description":"Owner before transfer."},"new_owner_info":{"type":"object","properties":{"user_id":{"type":"string","description":"New owner user ID.","example":"bYzq4sdfR16QF4dDe1Ex_B"},"user_email":{"type":"string","description":"New owner email.","example":"new-owner@example.com"},"account_id":{"type":"string","description":"New owner account ID if available.","example":"d3w1Tgsps6Sm2PbB4rmk1cPw"}},"description":"Owner after transfer."}},"description":"Triggered when file ownership is transferred."},{"title":"file_collaborator_added","type":"object","properties":{"file":{"type":"object","properties":{"file_id":{"type":"string","description":"File ID.","example":"XbGoj7lnTlCAAf7Qp1FryQ"},"account_id":{"type":"string","description":"Zoom account ID.","example":"d3w1Tgsps6Sm2PbB4rmk1cPw"},"file_type":{"type":"string","description":"File type.","example":"doc"},"file_name":{"type":"string","description":"File name.","example":"Project Plan"},"product_id":{"type":"string","description":"Product ID.","example":"docs"},"shortcut_original_file_type":{"type":"string","description":"Original type if shortcut.","example":"doc"}},"description":"File metadata."},"collaborator_type":{"type":"string","description":"Collaborator type.","example":"user"},"is_external":{"type":"boolean","description":"Whether collaborator is external.","example":false},"collaborator_role":{"type":"string","description":"Role assigned to collaborator.","example":"editor"}},"description":"Triggered when a collaborator is added."},{"title":"file_collaborator_deleted","type":"object","properties":{"file":{"type":"object","properties":{"file_id":{"type":"string","description":"File ID.","example":"XbGoj7lnTlCAAf7Qp1FryQ"},"account_id":{"type":"string","description":"Zoom account ID.","example":"d3w1Tgsps6Sm2PbB4rmk1cPw"},"file_type":{"type":"string","description":"File type.","example":"doc"},"file_name":{"type":"string","description":"File name.","example":"Project Plan"},"product_id":{"type":"string","description":"Product ID.","example":"docs"},"shortcut_original_file_type":{"type":"string","description":"Original type if shortcut.","example":"doc"}},"description":"File metadata."},"collaborator_type":{"type":"string","description":"Collaborator type.","example":"email"},"is_external":{"type":"boolean","description":"Whether collaborator is external.","example":true},"collaborator_role":{"type":"string","description":"Role before removal.","example":"viewer"}},"description":"Triggered when a collaborator is removed."},{"title":"file_collaborator_changed","type":"object","properties":{"file":{"type":"object","properties":{"file_id":{"type":"string","description":"File ID.","example":"XbGoj7lnTlCAAf7Qp1FryQ"},"account_id":{"type":"string","description":"Zoom account ID.","example":"d3w1Tgsps6Sm2PbB4rmk1cPw"},"file_type":{"type":"string","description":"File type.","example":"doc"},"file_name":{"type":"string","description":"File name.","example":"Project Plan"},"product_id":{"type":"string","description":"Product ID.","example":"docs"},"shortcut_original_file_type":{"type":"string","description":"Original type if shortcut.","example":"doc"}},"description":"File metadata."},"collaborator_type":{"type":"string","description":"Collaborator type.","example":"user"},"is_external":{"type":"boolean","description":"Whether collaborator is external.","example":false},"new_collaborator_role":{"type":"string","description":"Role after update.","example":"commenter"}},"description":"Triggered when collaborator role changes."},{"title":"file_general_access_changed","type":"object","properties":{"file":{"type":"object","properties":{"file_id":{"type":"string","description":"File ID.","example":"XbGoj7lnTlCAAf7Qp1FryQ"},"account_id":{"type":"string","description":"Zoom account ID.","example":"d3w1Tgsps6Sm2PbB4rmk1cPw"},"file_type":{"type":"string","description":"File type.","example":"doc"},"file_name":{"type":"string","description":"File name.","example":"Project Plan"},"product_id":{"type":"string","description":"Product ID.","example":"docs"},"shortcut_original_file_type":{"type":"string","description":"Original type if shortcut.","example":"doc"}},"description":"File metadata."},"old_general_access":{"type":"object","properties":{"share_scope":{"type":"string","description":"Previous share scope.","example":"collaborators_only"},"role":{"type":"string","description":"Previous role.","example":"viewer"}},"description":"General access before update."},"new_general_access":{"type":"object","properties":{"share_scope":{"type":"string","description":"New share scope.","example":"anyone_with_link"},"role":{"type":"string","description":"New role.","example":"commenter"}},"description":"General access after update."}},"description":"Triggered when file general access changes."},{"title":"file_copied","type":"object","properties":{"file":{"type":"object","properties":{"file_id":{"type":"string","description":"Source file ID.","example":"src_001"},"account_id":{"type":"string","description":"Source account ID.","example":"d3w1Tgsps6Sm2PbB4rmk1cPw"},"file_type":{"type":"string","description":"Source file type.","example":"doc"},"file_name":{"type":"string","description":"Source file name.","example":"Template"},"product_id":{"type":"string","description":"Source product ID.","example":"docs"},"shortcut_original_file_type":{"type":"string","description":"Original type if shortcut.","example":"doc"}},"description":"Source file metadata."},"target_file":{"type":"object","properties":{"file_id":{"type":"string","description":"Target file ID.","example":"target_002"},"account_id":{"type":"string","description":"Target account ID.","example":"d3w1Tgsps6Sm2PbB4rmk1cPw"},"file_type":{"type":"string","description":"Target file type.","example":"doc"},"file_name":{"type":"string","description":"Target file name.","example":"Template Copy"},"product_id":{"type":"string","description":"Target product ID.","example":"docs"},"shortcut_original_file_type":{"type":"string","description":"Original type if shortcut.","example":"doc"}},"description":"Copied target file metadata."}},"description":"Triggered when a file is copied."},{"title":"file_exported","type":"object","properties":{"file":{"type":"object","properties":{"file_id":{"type":"string","description":"File ID.","example":"exp_001"},"account_id":{"type":"string","description":"Zoom account ID.","example":"d3w1Tgsps6Sm2PbB4rmk1cPw"},"file_type":{"type":"string","description":"File type.","example":"doc"},"file_name":{"type":"string","description":"File name.","example":"Quarterly Report"},"product_id":{"type":"string","description":"Product ID.","example":"docs"},"shortcut_original_file_type":{"type":"string","description":"Original type if shortcut.","example":"doc"}},"description":"Exported file metadata."}},"description":"Triggered when a file is exported/downloaded."},{"title":"file_printed","type":"object","properties":{"file":{"type":"object","properties":{"file_id":{"type":"string","description":"File ID.","example":"prt_001"},"account_id":{"type":"string","description":"Zoom account ID.","example":"d3w1Tgsps6Sm2PbB4rmk1cPw"},"file_type":{"type":"string","description":"File type.","example":"doc"},"file_name":{"type":"string","description":"File name.","example":"Invoice 2026-01"},"product_id":{"type":"string","description":"Product ID.","example":"docs"},"shortcut_original_file_type":{"type":"string","description":"Original type if shortcut.","example":"doc"}},"description":"Printed file metadata."}},"description":"Triggered when a file is printed."},{"title":"file_moved_to_trash","type":"object","properties":{"file":{"type":"object","properties":{"file_id":{"type":"string","description":"File ID.","example":"trash_001"},"account_id":{"type":"string","description":"Zoom account ID.","example":"d3w1Tgsps6Sm2PbB4rmk1cPw"},"file_type":{"type":"string","description":"File type.","example":"doc"},"file_name":{"type":"string","description":"File name.","example":"Deprecated Notes"},"product_id":{"type":"string","description":"Product ID.","example":"docs"},"shortcut_original_file_type":{"type":"string","description":"Original type if shortcut.","example":"doc"}},"description":"Trashed file metadata."}},"description":"Triggered when a file is moved to trash."},{"title":"file_restored_from_trash","type":"object","properties":{"file":{"type":"object","properties":{"file_id":{"type":"string","description":"File ID.","example":"trash_001"},"account_id":{"type":"string","description":"Zoom account ID.","example":"d3w1Tgsps6Sm2PbB4rmk1cPw"},"file_type":{"type":"string","description":"File type.","example":"doc"},"file_name":{"type":"string","description":"File name.","example":"Recovered Notes"},"product_id":{"type":"string","description":"Product ID.","example":"docs"},"shortcut_original_file_type":{"type":"string","description":"Original type if shortcut.","example":"doc"}},"description":"Restored file metadata."}},"description":"Triggered when a file is restored from trash."},{"title":"file_permanently_deleted","type":"object","properties":{"file":{"type":"object","properties":{"file_id":{"type":"string","description":"File ID.","example":"del_001"},"account_id":{"type":"string","description":"Zoom account ID.","example":"d3w1Tgsps6Sm2PbB4rmk1cPw"},"file_type":{"type":"string","description":"File type.","example":"doc"},"file_name":{"type":"string","description":"File name at deletion.","example":"Temp Draft"},"product_id":{"type":"string","description":"Product ID.","example":"docs"},"shortcut_original_file_type":{"type":"string","description":"Original type if shortcut.","example":"doc"}},"description":"Deleted file metadata."}},"description":"Triggered when a file is permanently deleted."},{"title":"file_published","type":"object","properties":{"file":{"type":"object","properties":{"file_id":{"type":"string","description":"File ID.","example":"pub_001"},"account_id":{"type":"string","description":"Zoom account ID.","example":"d3w1Tgsps6Sm2PbB4rmk1cPw"},"file_type":{"type":"string","description":"File type.","example":"doc"},"file_name":{"type":"string","description":"Published file name.","example":"Public FAQ"},"product_id":{"type":"string","description":"Product ID.","example":"docs"},"shortcut_original_file_type":{"type":"string","description":"Original type if shortcut.","example":"doc"}},"description":"Published file metadata."}},"description":"Triggered when a file is published."},{"title":"file_unpublished","type":"object","properties":{"file":{"type":"object","properties":{"file_id":{"type":"string","description":"File ID.","example":"pub_001"},"account_id":{"type":"string","description":"Zoom account ID.","example":"d3w1Tgsps6Sm2PbB4rmk1cPw"},"file_type":{"type":"string","description":"File type.","example":"doc"},"file_name":{"type":"string","description":"Unpublished file name.","example":"Public FAQ"},"product_id":{"type":"string","description":"Product ID.","example":"docs"},"shortcut_original_file_type":{"type":"string","description":"Original type if shortcut.","example":"doc"}},"description":"Unpublished file metadata."}},"description":"Triggered when a file is unpublished."},{"title":"file_moved","type":"object","properties":{"file":{"type":"object","properties":{"file_id":{"type":"string","description":"File ID.","example":"mv_001"},"account_id":{"type":"string","description":"Zoom account ID.","example":"d3w1Tgsps6Sm2PbB4rmk1cPw"},"file_type":{"type":"string","description":"File type.","example":"doc"},"file_name":{"type":"string","description":"File name.","example":"Roadmap"},"product_id":{"type":"string","description":"Product ID.","example":"docs"},"shortcut_original_file_type":{"type":"string","description":"Original type if shortcut.","example":"doc"}},"description":"Moved file metadata (new location)."},"old_file_ancestors":{"type":"array","description":"Old ancestors before moving.","example":[{"file_id":"oldFolder123","file_name":"Old Folder","file_type":"folder","user_id":"aCdqwwghR16QF4dDe1Ex_A"}],"items":{"type":"object","properties":{"file_id":{"type":"string","description":"Ancestor file ID.","example":"oldFolder123"},"file_name":{"type":"string","description":"Ancestor file name.","example":"Old Folder"},"file_type":{"type":"string","description":"Ancestor file type.","example":"folder","enum":["root","folder","shared_folder","doc","data_table"]},"user_id":{"type":"string","description":"User ID for default space if available.","example":"aCdqwwghR16QF4dDe1Ex_A"}},"description":"Old ancestor node."}}},"description":"Triggered when a file is moved."},{"title":"file_attachment_downloaded","type":"object","properties":{"file":{"type":"object","properties":{"file_id":{"type":"string","description":"File ID.","example":"att_doc_001"},"account_id":{"type":"string","description":"Zoom account ID.","example":"d3w1Tgsps6Sm2PbB4rmk1cPw"},"file_type":{"type":"string","description":"File type.","example":"doc"},"file_name":{"type":"string","description":"File name.","example":"Budget 2026"},"product_id":{"type":"string","description":"Product ID.","example":"docs"},"shortcut_original_file_type":{"type":"string","description":"Original type if shortcut.","example":"doc"}},"description":"File metadata."},"attachment_id":{"type":"string","description":"Attachment ID.","example":"att_9f2kLm"},"attachment_name":{"type":"string","description":"Attachment name.","example":"Budget.xlsx"}},"description":"Triggered when file attachment is downloaded."},{"title":"file_attachment_previewed","type":"object","properties":{"file":{"type":"object","properties":{"file_id":{"type":"string","description":"File ID.","example":"att_doc_001"},"account_id":{"type":"string","description":"Zoom account ID.","example":"d3w1Tgsps6Sm2PbB4rmk1cPw"},"file_type":{"type":"string","description":"File type.","example":"doc"},"file_name":{"type":"string","description":"File name.","example":"Budget 2026"},"product_id":{"type":"string","description":"Product ID.","example":"docs"},"shortcut_original_file_type":{"type":"string","description":"Original type if shortcut.","example":"doc"}},"description":"File metadata."},"attachment_id":{"type":"string","description":"Attachment ID.","example":"att_9f2kLm"},"attachment_name":{"type":"string","description":"Attachment name.","example":"Budget.xlsx"}},"description":"Triggered when file attachment is previewed."},{"title":"file_comment_created","type":"object","properties":{"file":{"type":"object","properties":{"file_id":{"type":"string","description":"File ID.","example":"cmt_doc_001"},"account_id":{"type":"string","description":"Zoom account ID.","example":"d3w1Tgsps6Sm2PbB4rmk1cPw"},"file_type":{"type":"string","description":"File type.","example":"doc"},"file_name":{"type":"string","description":"File name.","example":"Review Notes"},"product_id":{"type":"string","description":"Product ID.","example":"docs"},"shortcut_original_file_type":{"type":"string","description":"Original type if shortcut.","example":"doc"}},"description":"File metadata."},"comment_id":{"type":"string","description":"Comment ID.","example":"cmt_123456"},"thread_id":{"type":"string","description":"Comment thread ID.","example":"thr_123456"}},"description":"Triggered when a comment is created."},{"title":"file_comment_changed","type":"object","properties":{"file":{"type":"object","properties":{"file_id":{"type":"string","description":"File ID.","example":"cmt_doc_001"},"account_id":{"type":"string","description":"Zoom account ID.","example":"d3w1Tgsps6Sm2PbB4rmk1cPw"},"file_type":{"type":"string","description":"File type.","example":"doc"},"file_name":{"type":"string","description":"File name.","example":"Review Notes"},"product_id":{"type":"string","description":"Product ID.","example":"docs"},"shortcut_original_file_type":{"type":"string","description":"Original type if shortcut.","example":"doc"}},"description":"File metadata."},"comment_id":{"type":"string","description":"Comment ID.","example":"cmt_123456"},"thread_id":{"type":"string","description":"Comment thread ID.","example":"thr_123456"}},"description":"Triggered when a comment is edited."},{"title":"file_comment_deleted","type":"object","properties":{"file":{"type":"object","properties":{"file_id":{"type":"string","description":"File ID.","example":"cmt_doc_001"},"account_id":{"type":"string","description":"Zoom account ID.","example":"d3w1Tgsps6Sm2PbB4rmk1cPw"},"file_type":{"type":"string","description":"File type.","example":"doc"},"file_name":{"type":"string","description":"File name.","example":"Review Notes"},"product_id":{"type":"string","description":"Product ID.","example":"docs"},"shortcut_original_file_type":{"type":"string","description":"Original type if shortcut.","example":"doc"}},"description":"File metadata."},"comment_id":{"type":"string","description":"Comment ID.","example":"cmt_123456"},"thread_id":{"type":"string","description":"Comment thread ID.","example":"thr_123456"}},"description":"Triggered when a comment is deleted."}]}}}},"next_page_token":{"type":"string","description":"The next page token is used to paginate through large result sets. A next page token is returned whenever the set of available results exceeds the current page size.","example":"eyJ0aW1lQ3Vyc29yIjoiMjAyNS0wNC0yMVQwOTo0NTo1OC45NTJaIiwiaWRDdXJzb3IiOiJzemFsMkpmTlFteTExY1JwdkYxRWhBIn0="}}}}}},"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_authorization":[]}],"x-extensions":{"x-permissions":["DocsActivityLog:Read"],"x-macro-scopes":["docs_activity_report:read:admin"],"x-granular-scopes":["docs:read:activity_report:admin"]}}},"/docs/file_search":{"post":{"tags":["Search"],"summary":"Search files","description":"Search for files accessible to the current user by query and filters (file_types, ancestor_ids, created_by, owner_id). Pagination uses an opaque next_page_token cursor. The first page should omit next_page_token; subsequent pages must pass it back unchanged along with the same filter parameters as the initial request. Changing any filter while providing next_page_token is invalid and will result in a 400 Bad Request.\n\n**[Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `canvas_file_search:write`\n\n**[Granular Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `canvas:write:file_search`\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":"Search","requestBody":{"description":"Search parameters, including the keyword, optional filters, and pagination token.","content":{"application/json":{"schema":{"type":"object","properties":{"query":{"maxLength":100,"minLength":1,"type":"string","description":"Optional. The search keyword. The API matches this keyword against file titles and searchable content.","example":"quarterly review"},"created_by":{"type":"string","description":"The unique ID of the user who created the file. When set, only files created by this user are returned.","example":"WpIVEe2v321Tb90PpjE5ag"},"ancestor_ids":{"maxItems":20,"minItems":1,"type":"array","description":"Ancestor folder or shared folder IDs that limit the search scope. If omitted, the API searches all locations accessible to the current user.","items":{"type":"string","description":"The ID of an ancestor folder or shared folder.","example":"lq59G-liS6Cq213SX5FNtA"}},"file_types":{"maxItems":8,"minItems":1,"uniqueItems":true,"type":"array","description":"File type filters. If omitted, the search covers all supported file types. Supported values: `doc`, `data_table`, `meeting_agenda`, `meeting_summary`, `note`, `paper_doc`, `spreadsheet`, `presentation`.","items":{"type":"string","description":"File types to filter by.\nAllowed values: `doc`, `data_table`, `meeting_agenda`, `meeting_summary`, `note`, `paper_doc`, `spreadsheet`, `presentation`.","example":"doc","enum":["paper_doc","presentation","spreadsheet","doc","data_table","note","meeting_summary","meeting_agenda"]}},"owner_id":{"type":"string","description":"The unique ID of the user who owns the file. When set, only files owned by this user are returned.","example":"WpIVEe2v321Tb90PpjE5ag"},"page_size":{"maximum":50,"minimum":1,"type":"integer","description":"The number of files to return per page. Range: 1 to 50. If omitted, the server default is used.","example":20},"next_page_token":{"type":"string","description":"The next page token is used to paginate through large result sets. A next page token is returned whenever the set of available results exceeds the current page size.","example":"eyJ0aW1lQ3Vyc29yIjoiMjAyNS0wNC0yMVQwOTo0NTo1OC45NTJaIiwiaWRDdXJzb3IiOiJzemFsMkpmTlFteTExY1JwdkYxRWhBIn0="},"created_time_from":{"type":"string","description":"Filter results created on or after this time. Cannot be used together with `modified_time_from` or `modified_time_to`.","format":"date-time","example":"2026-02-13T00:00:00Z"},"created_time_to":{"type":"string","description":"Filter results created on or before this time. Cannot be used together with `modified_time_from` or `modified_time_to`.","format":"date-time","example":"2026-02-20T23:59:59Z"},"modified_time_from":{"type":"string","description":"Filter results modified on or after this time. Cannot be used together with `created_time_from` or `created_time_to`.","format":"date-time","example":"2026-02-13T00:00:00Z"},"modified_time_to":{"type":"string","description":"Filter results modified on or before this time. Cannot be used together with `created_time_from` or `created_time_to`.","format":"date-time","example":"2026-02-20T23:59:59Z"}}}}}},"responses":{"200":{"description":"Returns matching files and a pagination token when more results are available.","content":{"application/json":{"schema":{"required":["files"],"type":"object","properties":{"files":{"maxItems":50,"type":"array","description":"Files that match the search query and filters. An empty array means no matching files were found.","items":{"required":["file_id","file_link","file_name","file_type"],"type":"object","properties":{"file_id":{"type":"string","description":"The file's unique ID.","example":"lq59G-liS6Cq213SX5FNtA"},"file_name":{"type":"string","description":"The display name of the file.","example":"Q2 Product Review"},"file_link":{"type":"string","description":"The direct URL to open the file.","format":"uri","example":"https://docs.zoom.us/doc/eXSiwenmABCBaoH7RcA3B1"},"file_type":{"type":"string","description":"The file's normalized type. Allowed values: `doc`, `data_table`, `meeting_agenda`, `meeting_summary`, `note`, `paper_doc`, `spreadsheet`, `presentation`.","example":"doc","enum":["paper_doc","presentation","spreadsheet","doc","data_table","note","meeting_summary","meeting_agenda"]}},"description":"The file object."}},"next_page_token":{"type":"string","description":"The next page token is used to paginate through large result sets. A next page token is returned whenever the set of available results exceeds the current page size.","example":"eyJ0aW1lQ3Vyc29yIjoiMjAyNS0wNC0yMVQwOTo0NTo1OC45NTJaIiwiaWRDdXJzb3IiOiJzemFsMkpmTlFteTExY1JwdkYxRWhBIn0="}}}}}},"400":{"description":"**HTTP Status Code:** `400` <br>\n Bad Request  Possible causes: `query` is invalid or malformed; `file_types` is empty or contains unsupported types; `page_size` is out of range; `next_page_token` is invalid or expired; time range is invalid (e.g. `_from` is after `_to`); `created_time_*` and `modified_time_*` filters cannot be used simultaneously. \n\n "},"403":{"description":"**HTTP Status Code:** `403` <br>\n Forbidden  You do not have permission to search files. \n\n "},"404":{"description":"**HTTP Status Code:** `404` <br>\n Not Found  The specified ancestor folder or shared folder was not found or is unavailable. \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_authorization":[]}],"x-extensions":{"x-permissions":[],"x-macro-scopes":["canvas_file_search:write"],"x-granular-scopes":["canvas:write:file_search"]}}}},"components":{"securitySchemes":{"openapi_authorization":{"scheme":"bearer","type":"http"}}},"tags":[{"name":"Archiving"},{"name":"Collaborator"},{"name":"DataTable Content"},{"name":"Doc Content"},{"name":"Export"},{"name":"File Management"},{"name":"File Uploads"},{"name":"General Access"},{"name":"Import"},{"name":"Report"},{"name":"Search"}]}