Sign in

v1

latestSwagger 2.02026-07-134146194.6 MB
EnvelopeTransferRules

Creates an envelope transfer rule.

This method creates an envelope transfer rule.

When you create an envelope transfer rule, you specify the following properties:

  • eventType
  • fromGroups
  • toUser
  • toFolder
  • carbonCopyOriginalOwner
  • enabled

Note: Only Administrators can create envelope transfer rules. In addition, to use envelope transfer rules, the Transfer Custody feature must be enabled for your account.

post/v2.1/accounts/{accountId}/envelopes/transfer_rules

Path parameters

accountIdstring required

The external account number (int) or account ID GUID.

Request body

carbonCopyOriginalOwnerstring

When true, the original owner is added as a carbon copy recipient after envelope transfer. The default value is false.

enabledstring

When true, the envelope transfer rule is active.

envelopeTransferRuleIdstring

The ID of the envelope transfer rule. The system generates this ID when the rule is first created.

eventTypestring

The type of envelope event that triggers the transfer. Valid values are:

  • sent
  • before sent
  • completed
modifiedDatestring

The UTC DateTime when the envelope transfer rule was last modified. This property is read-only.

Response

Successful response.