ClicksignInstall

Summary

Create a new signer and add them to a specified envelope within the Clicksign system.

Inputs

• Envelope ID (required) — The ID of the envelope to which the signer will be added.
• Nome (required) — The name of the signer, used for identification; must contain at least two words.
• Email (required) — The signer's email address; required if email notifications are enabled.
• Telefone — The signer's phone number with 10 or 11 digits; required if phone-based notifications are enabled.
• Possui CPF — Boolean indicating if the signer must provide CPF and birthdate information.
• CPF — The signer's CPF number, required if "Possui CPF" is true.
• Data De Nascimento — The signer's birthdate in formats like '10/10/1990' or '1990-10-10', required if "Possui CPF" is true.
• Grupo — The group number to assign to the signer, determining their signing order.
• Permitir Recusar a Solicitação De Assinatura — Boolean to specify whether the signer is allowed to refuse the signature request.
• Localização Necessária — Boolean to require the signer to share their location at the time of signing.
• Notificação De Eventos — Settings to configure different notification methods (none, email, WhatsApp, SMS) for signature request, signature reminder, and document signed events.

Output shape

a single record representing the created signer with details as returned by the Clicksign API

The output is a JSON object containing the signer's data after creation. The operation requires valid credentials and will fail if required fields or conditions (such as email or phone presence depending on notification settings) are not met.

Examples

Example 1: Create a signer with email notification for an existing envelope

Set Envelope ID, full name, email, and optionally other fields like CPF, birthdate, and group. Configure notification preferences as needed.