The Form API empowers teams to programmatically create, update, and delete custom forms within the magicplan ecosystem—without having to log in to the magicplan Cloud UI.

This API is ideal for organizations that already manage form content (like checklists, surveys, or structured field questions) in their internal tools and want to:

• Dynamically create or update forms in magicplan,

• Automate changes to form content as requirements evolve,

• Delete forms that are no longer relevant—with caution.

These capabilities allow tighter integration into existing business workflows, giving developers full control over the form lifecycle in an automated, centralized manner.

---

Example Scenario: Custom Form Management from an Internal SystemCopied!

Imagine a property management company that already stores predefined inspection checklists in their internal software. Instead of manually recreating or maintaining these in magicplan Cloud, they can use the Form API to:

1. Create Forms Automatically
   As new property types are added in their internal system, corresponding forms (e.g., “Luxury Apartment Pre-Rental Checklist”) are programmatically created in magicplan via the POST /forms endpoint.

2. Keep Form Content in Sync
   When a checklist is updated internally (e.g., new compliance questions are added), the PUT /forms/{id} endpoint allows syncing those changes instantly across all relevant forms in magicplan - without needing to manually edit anything.

3. Delete Outdated Forms Carefully
   If a form is no longer needed, the company can remove it using the DELETE /forms/{id} endpoint. However, form deletion is permanent:

   • Any users who had the form attached to projects will receive a notification in the magicplan app indicating that workspace settings have changed.

   • Once they click "Update" in the app, all questions from the deleted form are removed from their projects irreversibly.

This control-centric approach allows teams to manage their form definitions centrally, scale changes across projects and teams, and ensure consistency without manual intervention.

---

Example Use Case: Heating System Inspection WorkflowCopied!

Imagine a heating services company aiming to enhance its field inspection process by digitizing data collection and integrating it with their internal systems. They could utilize magicplan's Form API to achieve this goal:

1. Designing Custom Inspection Forms: The company creates tailored forms within magicplan Cloud, including fields for system type, condition assessments, maintenance requirements, and photo documentation.

2. Deploying Forms to Field Technicians: These forms are published to the company's workspace, making them accessible to technicians via the magicplan app during on-site inspections.

3. Collecting Structured Data On-Site: Technicians complete the forms during inspections, ensuring consistent and comprehensive data collection, including capturing photos and notes directly within the app.

4. Integrating with Internal CRM Systems: Post-inspection, the company uses the Project Plan API to retrieve the completed form data. This information is then automatically imported into their CRM, facilitating follow-up actions and maintenance scheduling.

This integration streamlines the inspection workflow, reduces manual data entry errors, and improves the efficiency of maintenance scheduling.

---

Key BenefitsCopied!

• Automation: Keep form content aligned with internal standards and changes.

• Consistency: Ensure field teams always use the most up-to-date forms.

• Integration: Connect form workflows to internal CRMs, ERPs, or compliance tools.

---

🔜 🧭 Planned EndpointsCopied!

The following endpoints are part of our extended roadmap and will be introduced in upcoming updates:

- Form Context Options

Retrieve the list of available context options — including custom room types and object categories — for dynamic form assignment.

- Publish a Form

Make a form active and available for use across projects in the workspace.

- Unpublish a Form

Temporarily deactivate a form without deleting it. Ideal for archiving or testing workflows.