Add a recipient
Adds a signer to an envelope.
Input
The ID of the envelope to which the recipient will be added.
The type of the recipient. For now, the only recipient type is signer.
The name of the recipient.
The email address of the recipient.
A user-provided key that identifies a recipient within an envelope.
It must be up to 32 alphanumeric, lowercase characters and must start with a letter. For example: buyer, employee, party2 are valid recipient keys.
Output
The ID of the recipient.
The name of the recipient.
The email address of the recipient.
A user-provided key that identifies a recipient within an envelope.
The current status of the recipient.
Available options are pending, sent, completed, rejected, soft_bounced, hard_bounced, failed, and replaced.
Time at which the envelope was completed by the recipient, in ISO 8601 format.
Was this page helpful?