docusign.envelope-transfer-rules.put-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.

Changes the status of an envelope transfer rule.

Overview

Property	Value
Workflow type	Atomic
Library	App-docusign
Version	1.0

Input Schema

Field	Type	Required	Default	Description
base_url	string	Yes	—	Docusign API root, e.g. https://<host>/api
api_token	string	No	—	Bearer token; omit to use the workflow's token env var
accountid	string	Yes	—	The external account number (int) or account ID GUID.
envelopetransferruleid	string	Yes	—	The ID of the envelope transfer rule. The system generates this ID when the rule is first created.
carboncopyoriginalowner	string	No	—	When true, the original owner is added as a carbon copy recipient after envelope transfer. The default value is false.
enabled	string	No	—	When true, the envelope transfer rule is active.
envelopetransferruleid_2	string	No	—	The ID of the envelope transfer rule. The system generates this ID when the rule is first created.
eventtype	string	No	—	The type of envelope event that triggers the transfer. Valid values are: - sent - before sent - completed
fromgroup	json	No	—	This object contains information about a group.
fromuser	json	No	—	User information.
modifieddate	string	No	—	The UTC DateTime when the envelope transfer rule was last modified. This property is read-only.
modifieduser	json	No	—	User information.
tofolder	json	No	—	This object contains details about a folder.
touser	json	No	—	User information.

Output Schema

Field	Type	Required	Default	Description
base_url	string	Yes	—	Docusign API root, e.g. https://<host>/api
api_token	string	No	—	Bearer token; omit to use the workflow's token env var
accountid	string	Yes	—	The external account number (int) or account ID GUID.
envelopetransferruleid	string	Yes	—	The ID of the envelope transfer rule. The system generates this ID when the rule is first created.
carboncopyoriginalowner	string	No	—	When true, the original owner is added as a carbon copy recipient after envelope transfer. The default value is false.
enabled	string	No	—	When true, the envelope transfer rule is active.
envelopetransferruleid_2	string	No	—	The ID of the envelope transfer rule. The system generates this ID when the rule is first created.
eventtype	string	No	—	The type of envelope event that triggers the transfer. Valid values are: - sent - before sent - completed
fromgroup	json	No	—	This object contains information about a group.
fromuser	json	No	—	User information.
modifieddate	string	No	—	The UTC DateTime when the envelope transfer rule was last modified. This property is read-only.
modifieduser	json	No	—	User information.
tofolder	json	No	—	This object contains details about a folder.
touser	json	No	—	User information.
status_code	integer	No	—	HTTP status code of the completed call
response	json	No	—	Parsed JSON response body
failure_reason	string	No	—	—
failure_type	string	No	—	—
failed_at	string	No	—	—
failed_step	string	No	—	—
failed_layer	string	No	—	—
failed_at_state	string	No	—	—
error	string	No	—	—
error_type	string	No	—	—

States

State	Initial	Terminal	Success	Auto-advance	Description
pending	Yes	No	—	execute	Waiting to call PUT /v2.1/accounts/{accountId}/envelopes/transfer_rules/
completed	No	Yes	Yes	—	HTTP call succeeded
failed	No	Yes	No	—	HTTP call failed

State Diagram

Transitions

From	Action	To	Description
pending	execute	completed	Perform PUT /v2.1/accounts/{accountId}/envelopes/transfer_rules/
* (any state)	fail	failed	Record the failure reason

API Usage

POST /api/workflows/start
Content-Type: application/json

{
  "workflow_type": "docusign.envelope-transfer-rules.put-envelope-transfer-rule",
  "initial_data": {
    "base_url": "value",
    "accountid": "value",
    "envelopetransferruleid": "value"
  }
}