New Endpoints: Doc Formats
11 days ago by Horea Porutiu
🚀 New Endpoints: Create and Manage Doc Formats
We are excited to announce a new set of endpoints that allow you to manage Doc Formats directly via the REST API. You can now programmatically create, retrieve, and delete these native documents on your Miro boards.
💡 What is a "Doc Format"?
To ensure you use the right endpoint, it is important to distinguish between Doc Formats and Documents:
- 📄 Doc Formats (New): Native Miro text documents that live on the canvas. They can contain rich text and embedded Miro widgets.
- 📎 Documents: Standard file uploads (such as PDFs or DOCX files) displayed on the board.
Example of a Doc Format:
Below is an example of a Doc Format containing an embedded ER Diagram. This is the specific item type these new endpoints interact with.
🛠️ New Endpoints
You can now automate the lifecycle of Doc Formats using the following methods:
- Create doc format item
POST
Add a new Doc Format to a specific board. - Get doc format item
GET
Retrieve details about a specific Doc Format. - Delete doc format item
DELETE
Remove a Doc Format from the board.
Note: We are looking to provide an
UPDATEendpoint in the future to allow for programmatic content editing. Stay tuned!