PipeRun API icon

PipeRun API

Interact with the PipeRun CRM API.

Actions220

Signatures → Adicionar Assinatura Em Documentos

AI-generated

Summary

Adds an email address as a signer to a PipeRun signature document by sending the document ID, email, and any configured optional values in the request body. Custom body fields or JSON and custom query parameters can also be added through Additional Parameters.

Inputs

  • Signature Document Id (required) — ID of the signature document to add the person to.
  • Email (required) — Signer’s email address.
  • Birth Day — Optional birth date for the signer; the UI does not specify a format.
  • Status — Optional signature status: 0 awaiting signature, 1 signed, or 2 canceled.
  • Witness — Optional participation type: 0 signer, 1 witness, or 2 observer.
  • Ip — Optional signer network IP address.
  • Type — Optional signature type: 1 simple signature or 2 digital certificate signature.
  • Custom Body Fields — Add custom key-value fields to the root request body. String values that look like JSON, numbers, or booleans are parsed into those types; expressions are supported.
  • Custom Body (JSON) — Merge a JSON object into the root request body. Invalid JSON raises an operation error.
  • Custom Query Parameters — Append custom key-value parameters to the request URL.
  • Custom Query (JSON) — Merge a JSON object of query parameters into the request URL. Invalid JSON raises an operation error.
  • Request Options — Configure batching, whether to accept invalid SSL certificates, an HTTP proxy, and request timeout. Defaults include 50 items per batch, a 1000 ms batch interval, SSL validation enabled, and a 10000 ms timeout.

Output shape

A list of items containing the API response.

The operation uses the PipeRun API and requires PipeRun API credentials. The source pack does not show a custom response transformation, so the response shape depends on the API.

Links

Discussion