Create PDF Form

View as Markdown
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

Headers

{{tenant_key_name}}stringOptional

Request

This endpoint expects a multipart form containing a file.
filefileRequired

Required when type=pdf: the fillable AcroForm PDF - mimes:pdf max 10MB

namestringRequired

Required: form template name - string max 255 - e.g. Daily Vehicle Inspection

typestringRequired

Required: form type - one of native|pdf - use pdf for an uploaded fillable PDF

display_onstringRequired

Required: where the form surfaces - one of office|technician|both

assigned_to_typestringRequired

Required: entity type the form attaches to - one of work_order|work_order_assignment|customer|customer_location|equipment|workforce_personnel

Response

Successful response