Sign in

v1

latestSwagger 2.02026-07-134146194.6 MB
EnvelopeTransferRules

Changes the status of an envelope transfer rule.

This method changes the status of an envelope transfer rule. You use this method to change whether or not the rule is enabled.

You must include the envelopeTransferRuleId both as a query parameter, and in the request body.

Note: You cannot change any other information about the envelope transfer rule. Only Administrators can update an envelope transfer rule. In addition, to use envelope transfer rules, the Transfer Custody feature must be enabled for your account.

put/v2.1/accounts/{accountId}/envelopes/transfer_rules/{envelopeTransferRuleId}

Path parameters

accountIdstring required

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

envelopeTransferRuleIdstring required

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

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.