PipeRun APIInstall

Summary

Creates an active or inactive custom form in PipeRun and configures its entity type, available pipelines or activity types, page content, styling, and fields. The request body can also include custom fields or JSON properties, and custom query parameters can be added.

Inputs

• Name (required) — Form name.
• Type (required) — Linked entity: 1 for opportunities, 2 for companies, or 3 for people.
• Status (required) — Whether the form is active (true) or inactive (false); defaults to true.
• Pipelines — JSON array of pipeline IDs where the form will be available.
• Activity Types — JSON array of activity type IDs that display the form after an activity is completed or marked as a no-show in the mobile app.
• Page Title — Title of the form page.
• Page Content — Text content of the form page.
• Page Background Color — Background color of the public form page.
• Page Text Color — Text color for the form page.
• Page Logo Url — Image URL for the form logo. If omitted, the account's default logo is used.
• Form Background Color — Form background color.
• Form Text Color — Text color for the public form page content.
• Form Button Background Color — Form button background color.
• Form Button Text Color — Form button text color.
• Form With Rounded Borders — Whether to round the form's borders; defaults to true.
• Form Show Icons — Whether to show icons in form fields; defaults to true.
• Fields — JSON object keyed by each field's position, with field information as its value. The description identifies these as native or custom form fields.
• Custom Body Fields — Add named values to the root request body. String values that parse as JSON objects, arrays, booleans, or numbers are converted to those types.
• Custom Body (JSON) — JSON object merged into the root request body. Its properties are applied after Custom Body Fields and replace matching keys.
• Custom Query Parameters — Add named query parameters to the request URL.
• Custom Query (JSON) — JSON object merged into the request query parameters; its properties replace matching keys from Custom Query Parameters.
• Request Options — Configure request batching, SSL certificate validation, an HTTP proxy, or timeout. Defaults include batches of 50 with a 1000 ms interval and a 10000 ms timeout.

Output shape

A single API response item.

The operation sends a request to the PipeRun API at https://api.pipe.run/v1 using the configured PipeRun credentials. The source does not specify the response fields.

Links

• n8n community nodes installation guide