Input

Recipient Name
string
required

The name of the recipient.

Recipient Email
string
required

The email address of the recipient.

Recipient Key
string
required

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.

Envelope ID
string
required

The ID of the envelope to which the recipient will be added.

Recipient Ceremony Creation
string

How the ceremonies for a recipient are created. It can be automatic, where the recipient will be created the ceremony immediately and send via email, or manual, where the recipient will be created but the ceremony will be created later.

Recipient Delivery Type
string

How the deliverable is sent to the recipient. It can be email, where the recipient will receive an email with the deliverable, or none, where the recipient will not receive the deliverable.

Extra Properties
string

Extra properties for extensibility.

Output

Recipient Name
string

The name of the recipient.

Recipient Email
string

The email address of the recipient.

Recipient Key
string

A user-provided key that identifies a recipient within an envelope.

Recipient ID
string

The ID of the recipient.

Recipient Ceremony Creation
string

How the ceremonies for a recipient are created.

Recipient Delivery Type
string

How the deliverable is sent to the recipient.