docusign.envelope-transfer-rules.put-envelope-transfer-rules

This method changes the status for one or more envelope transfer rules based on the envelopeTransferRuleIds in the request body. You use this method to change whether or not the rules are enabled. Note: You cannot change any other information about the envelope transfer rule. Only Administrators can update envelope transfer rules. In addition, to use envelope transfer rules, the Transfer Custody feature must be enabled for your account.

Changes the status of multiple envelope transfer rules.

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.
endposition	string	No	—	The last index position in the result set.
envelopetransferrules	list	No	—	Contains information about a specific envelope transfer rule.
nexturi	string	No	—	The URI for the next chunk of records based on the search request. It is null if this is the last set of results for the search.
previousuri	string	No	—	The URI for the prior chunk of records based on the search request. It is null if this is the first set of results for the search.
resultsetsize	string	No	—	The number of results in this response. Because you can filter which entries are included in the response, this value is always less than or equal to the totalSetSize.
startposition	string	No	—	The starting index position of the current result set.
totalsetsize	string	No	—	The total number of items in the result set. This value is always greater than or equal to the value of resultSetSize.

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.
endposition	string	No	—	The last index position in the result set.
envelopetransferrules	list	No	—	Contains information about a specific envelope transfer rule.
nexturi	string	No	—	The URI for the next chunk of records based on the search request. It is null if this is the last set of results for the search.
previousuri	string	No	—	The URI for the prior chunk of records based on the search request. It is null if this is the first set of results for the search.
resultsetsize	string	No	—	The number of results in this response. Because you can filter which entries are included in the response, this value is always less than or equal to the totalSetSize.
startposition	string	No	—	The starting index position of the current result set.
totalsetsize	string	No	—	The total number of items in the result set. This value is always greater than or equal to the value of resultSetSize.
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-rules",
  "initial_data": {
    "base_url": "value",
    "accountid": "value"
  }
}