Skip to navigation
Docusign eSignature REST APIEnvelopes

EnvelopeTransferRules Resource

View as Markdown

Envelope transfer rules enable administrators to transfer envelopes and templates from user to another. For example, you might do this when an employee leaves the company. To transfer ownership of envelopes and templates, the Transfer Custody feature must be enabled for your account.

For more information about this functionality, see Transfer Envelopes and Templates.

Methods supported

MethodDescription
createPOST /restapi/v2.1/accounts/{accountId}/envelopes/transfer_rules
Creates an envelope transfer rule.
deleteDEL /restapi/v2.1/accounts/{accountId}/envelopes/transfer_rules/{envelopeTransferRuleId}
Deletes an envelope transfer rule.
getGET /restapi/v2.1/accounts/{accountId}/envelopes/transfer_rules
Gets envelope transfer rules.
updatePUT /restapi/v2.1/accounts/{accountId}/envelopes/transfer_rules
Changes the status of multiple envelope transfer rules.
updateEnvelopeTransferRulePUT /restapi/v2.1/accounts/{accountId}/envelopes/transfer_rules/{envelopeTransferRuleId}
Changes the status of an envelope transfer rule.

EnvelopeTransferRules properties

PropertyTypeDescription
endPositionstringThe last index position in the result set.
envelopeTransferRulesarrayContains information about a specific envelope transfer rule.
nextUristringThe 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.
previousUristringThe 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.
resultSetSizestringThe 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.
startPositionstringThe starting index position of the current result set.
totalSetSizestringThe total number of items in the result set. This value is always greater than or equal to the value of resultSetSize.