> For clean Markdown of any page, append .md to the page URL. > For a complete documentation index, see https://docs.itspropel.com/llms.txt. > For full documentation content, see https://docs.itspropel.com/llms-full.txt. > For AI client integration (Claude Code, Cursor, etc.), connect to the MCP server at https://docs.itspropel.com/_mcp/server. # Create Draft Form POST https://forms Content-Type: multipart/form-data Validation rules: - name: required|string|max:255 - description: nullable|string - display_on: required|in:office,technician,both - assigned_to_type: required|in:work_order,work_order_assignment,customer,customer_location,equipment,workforce_personnel - type: nullable|in:native,pdf (cannot be changed after creation) - source: sometimes|in:manual,imported - allow_multiple_submissions: sometimes|boolean - show_business_unit_logo: sometimes|boolean - allow_email_when_unfilled: sometimes|boolean - auto_email_on_completion: sometimes|boolean - layout: sometimes|in:one_column,two_column - business_unit_ids: sometimes|array of existing tenant_location IDs Reference: https://docs.itspropel.com/propel-biz/33-forms/01-forms-templates/create-draft-form ## OpenAPI Specification ```yaml openapi: 3.1.0 info: title: PropelBiz version: 1.0.0 paths: /forms: post: operationId: create-draft-form summary: Create Draft Form description: >- Validation rules: - name: required|string|max:255 - description: nullable|string - display_on: required|in:office,technician,both - assigned_to_type: required|in:work_order,work_order_assignment,customer,customer_location,equipment,workforce_personnel - type: nullable|in:native,pdf (cannot be changed after creation) - source: sometimes|in:manual,imported - allow_multiple_submissions: sometimes|boolean - show_business_unit_logo: sometimes|boolean - allow_email_when_unfilled: sometimes|boolean - auto_email_on_completion: sometimes|boolean - layout: sometimes|in:one_column,two_column - business_unit_ids: sometimes|array of existing tenant_location IDs tags: - subpackage_33Forms.subpackage_33Forms/01FormsTemplates parameters: - name: '{{tenant_key_name}}' in: header required: false schema: type: string responses: '200': description: Successful response content: application/json: schema: $ref: >- #/components/schemas/33 Forms_01 Forms Templates_Create Draft Form_Response_200 requestBody: content: multipart/form-data: schema: type: object properties: name: type: string description: 'Required: string, max:255 - Form template name' type: type: string description: >- Optional: enum(native|pdf) - Form type (cannot be changed after creation) layout: type: string description: 'Optional: enum(one_column|two_column) - Form layout style' source: type: string description: >- Optional: enum(manual|imported) - Source of the form template display_on: type: string description: 'Required: enum(office|technician|both) - Where form is shown' description: type: string description: 'Optional: string|null - Form description' assigned_to_type: type: string description: >- Required: enum(work_order|work_order_assignment|customer|customer_location|equipment|workforce_personnel) - Assigned entity type show_business_unit_logo: type: string description: 'Optional: boolean - Show business unit logo on form' auto_email_on_completion: type: string description: >- Optional: boolean - Automatically send email when form is completed allow_email_when_unfilled: type: string description: >- Optional: boolean - Allow email to be sent when form is unfilled allow_multiple_submissions: type: string description: 'Optional: boolean - Allow multiple submissions per entity' required: - name - type - layout - source - display_on - description - assigned_to_type - show_business_unit_logo - auto_email_on_completion - allow_email_when_unfilled - allow_multiple_submissions servers: - url: https:/ components: schemas: 33 Forms_01 Forms Templates_Create Draft Form_Response_200: type: object properties: {} description: Empty response body title: 33 Forms_01 Forms Templates_Create Draft Form_Response_200 ``` ## SDK Code Examples ```python import requests url = "https://https/forms" payload = "-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"name\"\r\n\r\nMonthly Safety Inspection\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"type\"\r\n\r\nnative\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"layout\"\r\n\r\ntwo_column\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"source\"\r\n\r\nmanual\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"display_on\"\r\n\r\nboth\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"description\"\r\n\r\nForm used for monthly safety checks in the field and office.\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"assigned_to_type\"\r\n\r\nwork_order\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"show_business_unit_logo\"\r\n\r\ntrue\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"auto_email_on_completion\"\r\n\r\nfalse\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"allow_email_when_unfilled\"\r\n\r\nfalse\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"allow_multiple_submissions\"\r\n\r\ntrue\r\n-----011000010111000001101001--\r\n" headers = { "{{tenant_key_name}}": "{{tenant_key_value1}}|{{tenant_key_value2}}", "Content-Type": "multipart/form-data; boundary=---011000010111000001101001" } response = requests.post(url, data=payload, headers=headers) print(response.json()) ``` ```javascript const url = 'https://https/forms'; const form = new FormData(); form.append('name', 'Monthly Safety Inspection'); form.append('type', 'native'); form.append('layout', 'two_column'); form.append('source', 'manual'); form.append('display_on', 'both'); form.append('description', 'Form used for monthly safety checks in the field and office.'); form.append('assigned_to_type', 'work_order'); form.append('show_business_unit_logo', 'true'); form.append('auto_email_on_completion', 'false'); form.append('allow_email_when_unfilled', 'false'); form.append('allow_multiple_submissions', 'true'); const options = { method: 'POST', headers: {'{{tenant_key_name}}': '{{tenant_key_value1}}|{{tenant_key_value2}}'} }; options.body = form; try { const response = await fetch(url, options); const data = await response.json(); console.log(data); } catch (error) { console.error(error); } ``` ```go package main import ( "fmt" "strings" "net/http" "io" ) func main() { url := "https://https/forms" payload := strings.NewReader("-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"name\"\r\n\r\nMonthly Safety Inspection\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"type\"\r\n\r\nnative\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"layout\"\r\n\r\ntwo_column\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"source\"\r\n\r\nmanual\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"display_on\"\r\n\r\nboth\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"description\"\r\n\r\nForm used for monthly safety checks in the field and office.\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"assigned_to_type\"\r\n\r\nwork_order\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"show_business_unit_logo\"\r\n\r\ntrue\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"auto_email_on_completion\"\r\n\r\nfalse\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"allow_email_when_unfilled\"\r\n\r\nfalse\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"allow_multiple_submissions\"\r\n\r\ntrue\r\n-----011000010111000001101001--\r\n") req, _ := http.NewRequest("POST", url, payload) req.Header.Add("{{tenant_key_name}}", "{{tenant_key_value1}}|{{tenant_key_value2}}") res, _ := http.DefaultClient.Do(req) defer res.Body.Close() body, _ := io.ReadAll(res.Body) fmt.Println(res) fmt.Println(string(body)) } ``` ```ruby require 'uri' require 'net/http' url = URI("https://https/forms") http = Net::HTTP.new(url.host, url.port) http.use_ssl = true request = Net::HTTP::Post.new(url) request["{{tenant_key_name}}"] = '{{tenant_key_value1}}|{{tenant_key_value2}}' request.body = "-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"name\"\r\n\r\nMonthly Safety Inspection\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"type\"\r\n\r\nnative\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"layout\"\r\n\r\ntwo_column\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"source\"\r\n\r\nmanual\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"display_on\"\r\n\r\nboth\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"description\"\r\n\r\nForm used for monthly safety checks in the field and office.\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"assigned_to_type\"\r\n\r\nwork_order\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"show_business_unit_logo\"\r\n\r\ntrue\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"auto_email_on_completion\"\r\n\r\nfalse\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"allow_email_when_unfilled\"\r\n\r\nfalse\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"allow_multiple_submissions\"\r\n\r\ntrue\r\n-----011000010111000001101001--\r\n" response = http.request(request) puts response.read_body ``` ```java import com.mashape.unirest.http.HttpResponse; import com.mashape.unirest.http.Unirest; HttpResponse response = Unirest.post("https://https/forms") .header("{{tenant_key_name}}", "{{tenant_key_value1}}|{{tenant_key_value2}}") .body("-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"name\"\r\n\r\nMonthly Safety Inspection\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"type\"\r\n\r\nnative\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"layout\"\r\n\r\ntwo_column\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"source\"\r\n\r\nmanual\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"display_on\"\r\n\r\nboth\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"description\"\r\n\r\nForm used for monthly safety checks in the field and office.\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"assigned_to_type\"\r\n\r\nwork_order\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"show_business_unit_logo\"\r\n\r\ntrue\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"auto_email_on_completion\"\r\n\r\nfalse\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"allow_email_when_unfilled\"\r\n\r\nfalse\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"allow_multiple_submissions\"\r\n\r\ntrue\r\n-----011000010111000001101001--\r\n") .asString(); ``` ```php request('POST', 'https://https/forms', [ 'multipart' => [ [ 'name' => 'name', 'contents' => 'Monthly Safety Inspection' ], [ 'name' => 'type', 'contents' => 'native' ], [ 'name' => 'layout', 'contents' => 'two_column' ], [ 'name' => 'source', 'contents' => 'manual' ], [ 'name' => 'display_on', 'contents' => 'both' ], [ 'name' => 'description', 'contents' => 'Form used for monthly safety checks in the field and office.' ], [ 'name' => 'assigned_to_type', 'contents' => 'work_order' ], [ 'name' => 'show_business_unit_logo', 'contents' => 'true' ], [ 'name' => 'auto_email_on_completion', 'contents' => 'false' ], [ 'name' => 'allow_email_when_unfilled', 'contents' => 'false' ], [ 'name' => 'allow_multiple_submissions', 'contents' => 'true' ] ] 'headers' => [ '{{tenant_key_name}}' => '{{tenant_key_value1}}|{{tenant_key_value2}}', ], ]); echo $response->getBody(); ``` ```csharp using RestSharp; var client = new RestClient("https://https/forms"); var request = new RestRequest(Method.POST); request.AddHeader("{{tenant_key_name}}", "{{tenant_key_value1}}|{{tenant_key_value2}}"); request.AddParameter("undefined", "-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"name\"\r\n\r\nMonthly Safety Inspection\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"type\"\r\n\r\nnative\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"layout\"\r\n\r\ntwo_column\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"source\"\r\n\r\nmanual\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"display_on\"\r\n\r\nboth\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"description\"\r\n\r\nForm used for monthly safety checks in the field and office.\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"assigned_to_type\"\r\n\r\nwork_order\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"show_business_unit_logo\"\r\n\r\ntrue\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"auto_email_on_completion\"\r\n\r\nfalse\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"allow_email_when_unfilled\"\r\n\r\nfalse\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"allow_multiple_submissions\"\r\n\r\ntrue\r\n-----011000010111000001101001--\r\n", ParameterType.RequestBody); IRestResponse response = client.Execute(request); ``` ```swift import Foundation let headers = ["{{tenant_key_name}}": "{{tenant_key_value1}}|{{tenant_key_value2}}"] let parameters = [ [ "name": "name", "value": "Monthly Safety Inspection" ], [ "name": "type", "value": "native" ], [ "name": "layout", "value": "two_column" ], [ "name": "source", "value": "manual" ], [ "name": "display_on", "value": "both" ], [ "name": "description", "value": "Form used for monthly safety checks in the field and office." ], [ "name": "assigned_to_type", "value": "work_order" ], [ "name": "show_business_unit_logo", "value": "true" ], [ "name": "auto_email_on_completion", "value": "false" ], [ "name": "allow_email_when_unfilled", "value": "false" ], [ "name": "allow_multiple_submissions", "value": "true" ] ] let boundary = "---011000010111000001101001" var body = "" var error: NSError? = nil for param in parameters { let paramName = param["name"]! body += "--\(boundary)\r\n" body += "Content-Disposition:form-data; name=\"\(paramName)\"" if let filename = param["fileName"] { let contentType = param["content-type"]! let fileContent = String(contentsOfFile: filename, encoding: String.Encoding.utf8) if (error != nil) { print(error as Any) } body += "; filename=\"\(filename)\"\r\n" body += "Content-Type: \(contentType)\r\n\r\n" body += fileContent } else if let paramValue = param["value"] { body += "\r\n\r\n\(paramValue)" } } let request = NSMutableURLRequest(url: NSURL(string: "https://https/forms")! as URL, cachePolicy: .useProtocolCachePolicy, timeoutInterval: 10.0) request.httpMethod = "POST" request.allHTTPHeaderFields = headers request.httpBody = postData as Data let session = URLSession.shared let dataTask = session.dataTask(with: request as URLRequest, completionHandler: { (data, response, error) -> Void in if (error != nil) { print(error as Any) } else { let httpResponse = response as? HTTPURLResponse print(httpResponse) } }) dataTask.resume() ```