PipeRun API icon

PipeRun API

Interact with the PipeRun CRM API.

Actions220

Regions → Adicionar Regiao

AI-generated

Summary

Creates a PipeRun region by sending the required name and any configured additional fields in the request body. You can set a parent region to make it a microregion, assign leaders and users, and specify a CEP range.

Inputs

  • Name (required) — Region name.
  • Region Id — Parent region ID; setting it makes the new region a microregion.
  • Leaders — JSON array of user IDs who lead the region, for example [12512, 12452].
  • Users — JSON array of user IDs who can access the region and receive lead distribution.
  • Cep From — Starting CEP for the region.
  • Cep To — Ending CEP for the region.
  • Custom Body Fields — Add key-value fields to the root request body. String values that parse as numbers, booleans, JSON objects, or arrays are converted to those types.
  • Custom Body (JSON) — JSON object merged into the root request body; fields with matching keys can override existing body fields.
  • Custom Query Parameters — Append named query parameters to the request URL.
  • Custom Query (JSON) — JSON object merged into the request query parameters; matching keys can override existing values.
  • Request Options — Configure batching, SSL certificate validation, an HTTP proxy, and request timeout.

Output shape

A single API response item.

The operation sends a request to the PipeRun API. The supplied source does not show the response schema or any transformation of the response.

Links

Discussion