PipeRun APIInstall

Summary

Updates a PipeRun business segment using its ID. Optionally sends a new name or description and merges custom fields or query parameters into the request.

Inputs

• Segment Id (required) — ID of the segment to update.
• Additional Parameters: Name — New segment name.
• Additional Parameters: Description — New segment description.
• Additional Parameters: Custom Body Fields — Add key/value pairs to the root request body. String values that look like JSON, booleans, or numbers are parsed when possible.
• Additional Parameters: Custom Body (JSON) — JSON object merged into the root request body; its keys overwrite matching body fields. Invalid JSON raises an operation error.
• Additional Parameters: Custom Query Parameters — Add key/value pairs to the request URL query. Keys matching existing query parameters are overwritten.
• Additional Parameters: Custom Query (JSON) — JSON object merged into the request query parameters; its keys overwrite matching parameters. Invalid JSON raises an operation error.
• Request Options — Configure request batching, SSL certificate validation, proxy, and timeout.

Output shape

A single API response item, as returned by PipeRun.

Requires PipeRun API credentials. Request options can batch incoming items; batch size -1 disables batching, and 0 is treated as 1.

Examples

Example 1: Rename a segment

Set Segment Id to the target segment's ID and provide the new value in Additional Parameters: Name.

Example 2: Send API-specific fields

Use Custom Body Fields or Custom Body (JSON) to add fields to the request body, or Custom Query Parameters or Custom Query (JSON) to add URL query parameters.

Links

• n8n community nodes installation guide