Change status of envelope transfer rule

PUT

/v2.1/accounts/:accountId/envelopes/transfer_rules/:envelopeTransferRuleId

PUT

/restapi/v2.1/accounts/:accountId/envelopes/transfer_rules/:envelopeTransferRuleId

curl -X PUT https://demo.docusign.net/restapi/v2.1/accounts/ACCOUNT_ID/envelopes/transfer_rules/ENVELOPE_TRANSFER_RULE_ID \
     -H "Authorization: Bearer <apiKey>" \
     -H "Content-Type: application/json" \
     -d '{
  "carbonCopyOriginalOwner": "sample string 1",
  "enabled": "sample string 2",
  "eventType": "sample string 4",
  "fromGroup": {
    "accessType": "sample string 1",
    "dsGroupId": "sample string 2",
    "errorDetails": {
      "errorCode": "sample string 1",
      "message": "sample string 2"
    },
    "groupId": "sample string 3",
    "groupName": "sample string 4",
    "groupType": "sample string 5",
    "isManagedByScim": true,
    "lastModifiedOn": "sample string 6",
    "permissionProfileId": "sample string 7",
    "userGroupType": "sample string 8",
    "users": [
      {
        "accountId": "sample string 1",
        "accountName": "sample string 2",
        "activationAccessCode": "sample string 3",
        "email": "sample string 4",
        "ipAddress": "sample string 5",
        "loginStatus": "sample string 6",
        "membershipId": "sample string 7",
        "sendActivationEmail": "sample string 8",
        "uri": "sample string 9",
        "userId": "sample string 10",
        "userName": "sample string 11",
        "userStatus": "sample string 12",
        "userType": "sample string 13"
      }
    ],
    "usersCount": "sample string 9"
  },
  "fromUser": {
    "activationAccessCode": "sample string 1",
    "company": "sample string 2",
    "connectConfigurations": [
      {
        "configurationtype": "sample string 1",
        "connectId": "sample string 2",
        "enabled": "sample string 3",
        "hasAccess": "sample string 4",
        "senderSearchableItems": [
          "sample string 1"
        ]
      }
    ],
    "countryCode": "sample string 3",
    "createdDateTime": "sample string 4",
    "customSettings": [
      {
        "name": "sample string 1",
        "originalValue": "sample string 2",
        "value": "sample string 3"
      }
    ],
    "defaultAccountId": "sample string 5",
    "email": "sample string 6",
    "enableConnectForUser": "sample string 7",
    "firstName": "sample string 8",
    "forgottenPasswordInfo": {
      "forgottenPasswordAnswer1": "sample string 1",
      "forgottenPasswordAnswer2": "sample string 2",
      "forgottenPasswordAnswer3": "sample string 3",
      "forgottenPasswordAnswer4": "sample string 4",
      "forgottenPasswordQuestion1": "sample string 5",
      "forgottenPasswordQuestion2": "sample string 6",
      "forgottenPasswordQuestion3": "sample string 7",
      "forgottenPasswordQuestion4": "sample string 8"
    },
    "groupList": [
      {}
    ],
    "hasRemoteNotary": true,
    "homeAddress": {
      "address1": "sample string 1",
      "address2": "sample string 2",
      "city": "sample string 3",
      "country": "sample string 4",
      "fax": "sample string 5",
      "phone": "sample string 6",
      "postalCode": "sample string 7",
      "stateOrProvince": "sample string 8",
      "zipPlus4": "sample string 9"
    },
    "initialsImageUri": "sample string 9",
    "isAdmin": "sample string 10",
    "isAlternateAdmin": "sample string 11",
    "isManagedByScim": "sample string 12",
    "isMembershipManagedByScim": "sample string 13",
    "isNAREnabled": "sample string 14",
    "jobTitle": "sample string 15",
    "lastLogin": "sample string 16",
    "lastName": "sample string 17",
    "licenseStatus": "sample string 18",
    "licenseType": "sample string 19",
    "licenseTypes": [
      "sample string 1"
    ],
    "loginStatus": "sample string 20",
    "middleName": "sample string 21",
    "password": "sample string 22",
    "passwordExpiration": "sample string 23",
    "permissionProfileId": "sample string 24",
    "permissionProfileName": "sample string 25",
    "profileImageUri": "sample string 26",
    "sendActivationEmail": "sample string 27",
    "sendActivationOnInvalidLogin": "sample string 28",
    "signatureImageUri": "sample string 29",
    "subscribe": "sample string 30",
    "suffixName": "sample string 31",
    "title": "sample string 32",
    "uri": "sample string 33",
    "userAddedToAccountDateTime": "sample string 34",
    "userId": "sample string 35",
    "userName": "sample string 36",
    "userProfileLastModifiedDate": "sample string 37",
    "userSettings": {
      "accountAgreementsAccessType": "sample string 1",
      "accountAgreementsAccessTypeMetadata": {
        "is21CFRPart11": "sample string 1",
        "options": [
          "sample string 1"
        ],
        "rights": "sample string 2",
        "uiHint": "sample string 3",
        "uiOrder": "sample string 4",
        "uiType": "sample string 5"
      },
      "accountManagementGranular": {
        "canManageAccountSecuritySettings": "sample string 1",
        "canManageAccountSettings": "sample string 2",
        "canManageAdmins": "sample string 3",
        "canManageConnect": "sample string 4",
        "canManageDocumentRetention": "sample string 5",
        "canManageEnvelopeTransfer": "sample string 6",
        "canManageGroupsButNotUsers": "sample string 7",
        "canManageJointAgreements": "sample string 8",
        "canManageReporting": "sample string 9",
        "canManageSharing": "sample string 10",
        "canManageSigningGroups": "sample string 11",
        "canManageStamps": "sample string 12",
        "canManageUsers": "sample string 13",
        "canViewOnlyAccountAdminPages": "sample string 14",
        "canViewUsers": "sample string 15"
      },
      "adminOnly": "sample string 2",
      "allowAccessToAllAccountAgreements": "sample string 3",
      "allowAutoTagging": "sample string 4",
      "allowedDocumentTemplateLibraryAccess": "sample string 5",
      "allowedOrchestrationAccess": "sample string 6",
      "allowEnvelopeTransferTo": "sample string 7",
      "allowEsealRecipients": "sample string 8",
      "allowPowerFormsAdminToAccessAllPowerFormEnvelope": "sample string 9",
      "allowRecipientLanguageSelection": "sample string 10",
      "allowSendOnBehalfOf": "sample string 11",
      "allowSupplementalDocuments": "sample string 12",
      "allowTransactions": "sample string 13",
      "anchorTagVersionedPlacementEnabled": "sample string 14",
      "apiAccountWideAccess": "sample string 15",
      "apiCanExportAC": "sample string 16",
      "bulkSend": "sample string 17",
      "canBulkUploadAgreements": "sample string 18",
      "canChargeAccount": "sample string 19",
      "canCreateTransaction": "sample string 20",
      "canDeleteDocumentsInTransaction": "sample string 21",
      "canDeleteTransaction": "sample string 22",
      "canEditSharedAddressbook": "sample string 23",
      "canLockEnvelopes": "sample string 24",
      "canManageAccount": "sample string 25",
      "canManageAgreementParties": "sample string 26",
      "canManageDistributor": "sample string 27",
      "canManageTemplates": "sample string 28",
      "canSendAPIRequests": "sample string 29",
      "canSendEnvelope": "sample string 30",
      "canSendEnvelopesViaSMS": "sample string 31",
      "canSignEnvelope": "sample string 32",
      "canUseScratchpad": "sample string 33",
      "canUseSmartContracts": "sample string 34",
      "disableDocumentUpload": "sample string 35",
      "disableOtherActions": "sample string 36",
      "enableDSPro": "sample string 37",
      "enableKeyTermsSuggestionsByDocumentType": "sample string 38",
      "enableSequentialSigningAPI": "sample string 39",
      "enableSequentialSigningUI": "sample string 40",
      "enableSignerAttachments": "sample string 41",
      "enableSignOnPaperOverride": "sample string 42",
      "enableTransactionPoint": "sample string 43",
      "enableVaulting": "sample string 44",
      "expressSendOnly": "sample string 45",
      "isManagedByScim": "sample string 46",
      "isMembershipManagedByScim": "sample string 47",
      "isMembershipRedacted": "sample string 48",
      "isUserRedacted": "sample string 49",
      "locale": "sample string 50",
      "localePolicy": {
        "addressFormat": "sample string 1",
        "allowRegion": "sample string 2",
        "calendarType": "sample string 3",
        "cultureName": "sample string 4",
        "currencyCode": "sample string 5",
        "currencyNegativeFormat": "sample string 6",
        "currencyPositiveFormat": "sample string 7",
        "customDateFormat": "sample string 8",
        "customSignDateFormat": "sample string 9",
        "customSignTimeFormat": "sample string 10",
        "customTimeFormat": "sample string 11",
        "dateFormat": "sample string 12",
        "effectiveAddressFormat": "sample string 13",
        "effectiveCalendarType": "sample string 14",
        "effectiveCurrencyCode": "sample string 15",
        "effectiveCurrencyNegativeFormat": "sample string 16",
        "effectiveCurrencyPositiveFormat": "sample string 17",
        "effectiveCustomDateFormat": "sample string 18",
        "effectiveCustomTimeFormat": "sample string 19",
        "effectiveDateFormat": "sample string 20",
        "effectiveInitialFormat": "sample string 21",
        "effectiveNameFormat": "sample string 22",
        "effectiveTimeFormat": "sample string 23",
        "effectiveTimeZone": "sample string 24",
        "initialFormat": "sample string 25",
        "nameFormat": "sample string 26",
        "signDateFormat": "sample string 27",
        "signTimeFormat": "sample string 28",
        "timeFormat": "sample string 29",
        "timeZone": "sample string 30"
      },
      "manageClickwrapsMode": "sample string 51",
      "modifiedBy": "sample string 52",
      "modifiedDate": "sample string 53",
      "modifiedPage": "sample string 54",
      "newSendUI": "sample string 55",
      "powerFormMode": "sample string 56",
      "recipientViewedNotification": "sample string 57",
      "redactMembershipAt": "sample string 58",
      "sealIdentifiers": [
        {
          "sealDisplayName": "sample string 1",
          "sealName": "sample string 2"
        }
      ],
      "selfSignedRecipientEmailDocument": "sample string 59",
      "senderEmailNotifications": {
        "changedSigner": "sample string 1",
        "clickwrapResponsesLimitNotificationEmail": "sample string 2",
        "commentsOnlyPrivateAndMention": "sample string 3",
        "commentsReceiveAll": "sample string 4",
        "deliveryFailed": "sample string 5",
        "envelopeComplete": "sample string 6",
        "offlineSigningFailed": "sample string 7",
        "powerformResponsesLimitNotificationEmail": "sample string 8",
        "purgeDocuments": "sample string 9",
        "recipientViewed": "sample string 10",
        "senderEnvelopeDeclined": "sample string 11",
        "withdrawnConsent": "sample string 12"
      },
      "signerEmailNotifications": {
        "agentNotification": "sample string 1",
        "carbonCopyNotification": "sample string 2",
        "certifiedDeliveryNotification": "sample string 3",
        "commentsOnlyPrivateAndMention": "sample string 4",
        "commentsReceiveAll": "sample string 5",
        "documentMarkupActivation": "sample string 6",
        "envelopeActivation": "sample string 7",
        "envelopeComplete": "sample string 8",
        "envelopeCorrected": "sample string 9",
        "envelopeDeclined": "sample string 10",
        "envelopeVoided": "sample string 11",
        "faxReceived": "sample string 12",
        "offlineSigningFailed": "sample string 13",
        "purgeDocuments": "sample string 14",
        "reassignedSigner": "sample string 15",
        "whenSigningGroupMember": "sample string 16"
      },
      "supplementalDocumentIncludeInDownload": "sample string 60",
      "supplementalDocumentsMustAccept": "sample string 61",
      "supplementalDocumentsMustRead": "sample string 62",
      "supplementalDocumentsMustView": "sample string 63",
      "templateActiveCreation": "sample string 64",
      "templateApplyNotify": "sample string 65",
      "templateAutoMatching": "sample string 66",
      "templateMatchingSensitivity": "sample string 67",
      "templatePageLevelMatching": "sample string 68",
      "timezoneDST": "sample string 69",
      "timezoneMask": "sample string 70",
      "timezoneOffset": "sample string 71",
      "timezoneSendingPref": "sample string 72",
      "timezoneSigningPref": "sample string 73",
      "transactionPointSiteNameURL": "sample string 74",
      "transactionPointUserName": "sample string 75",
      "vaultingMode": "sample string 76",
      "webForms": "sample string 77"
    },
    "userStatus": "sample string 38",
    "userType": "sample string 39"
  },
  "modifiedDate": "sample string 5",
  "toFolder": {
    "filter": {
      "actionRequired": "sample string 1",
      "expires": "sample string 2",
      "folderIds": "sample string 3",
      "fromDateTime": "sample string 4",
      "isTemplate": "sample string 5",
      "order": "sample string 6",
      "orderBy": "sample string 7",
      "searchTarget": "sample string 8",
      "searchText": "sample string 9",
      "status": "sample string 10",
      "toDateTime": "sample string 11"
    },
    "folderId": "sample string 1",
    "folderItems": [
      {
        "completedDateTime": "sample string 1",
        "createdDateTime": "sample string 2",
        "envelopeId": "sample string 3",
        "envelopeUri": "sample string 4",
        "expireDateTime": "sample string 5",
        "folderId": "sample string 6",
        "folderUri": "sample string 7",
        "is21CFRPart11": "sample string 8",
        "lastModifiedDateTime": "sample string 9",
        "ownerName": "sample string 10",
        "recipients": {
          "agents": [
            {}
          ],
          "authorizedSignatories": [
            {}
          ],
          "carbonCopies": [
            {}
          ],
          "certifiedDeliveries": [
            {}
          ],
          "currentRoutingOrder": "sample string 1",
          "editors": [
            {}
          ],
          "inPersonSigners": [
            {}
          ],
          "intermediaries": [
            {}
          ],
          "notaries": [
            {}
          ],
          "notaryWitnesses": [
            {}
          ],
          "participants": [
            {}
          ],
          "recipientCount": "sample string 2",
          "seals": [
            {}
          ],
          "signers": [
            {}
          ],
          "witnesses": [
            {}
          ]
        },
        "recipientsUri": "sample string 11",
        "senderCompany": "sample string 12",
        "senderEmail": "sample string 13",
        "senderName": "sample string 14",
        "senderUserId": "sample string 15",
        "sentDateTime": "sample string 16",
        "status": "sample string 17",
        "subject": "sample string 18",
        "templateId": "sample string 19",
        "templateUri": "sample string 20"
      }
    ],
    "folders": [
      {}
    ],
    "hasAccess": "sample string 2",
    "hasSubFolders": "sample string 3",
    "itemCount": "sample string 4",
    "name": "sample string 5",
    "parentFolderId": "sample string 6",
    "parentFolderUri": "sample string 7",
    "subFolderCount": "sample string 8",
    "type": "sample string 9",
    "uri": "sample string 10"
  }
}'

{
  "carbonCopyOriginalOwner": "sample string 1",
  "enabled": "sample string 2",
  "envelopeTransferRuleId": "sample string 3",
  "eventType": "sample string 4",
  "fromGroup": {
    "accessType": "sample string 1",
    "dsGroupId": "sample string 2",
    "errorDetails": {
      "errorCode": "sample string 1",
      "message": "sample string 2"
    },
    "groupId": "sample string 3",
    "groupName": "sample string 4",
    "groupType": "sample string 5",
    "isManagedByScim": true,
    "lastModifiedOn": "sample string 6",
    "permissionProfileId": "sample string 7",
    "userGroupType": "sample string 8",
    "users": [
      {
        "accountId": "sample string 1",
        "accountName": "sample string 2",
        "activationAccessCode": "sample string 3",
        "email": "sample string 4",
        "ipAddress": "sample string 5",
        "loginStatus": "sample string 6",
        "membershipId": "sample string 7",
        "sendActivationEmail": "sample string 8",
        "uri": "sample string 9",
        "userId": "sample string 10",
        "userName": "sample string 11",
        "userStatus": "sample string 12",
        "userType": "sample string 13"
      }
    ],
    "usersCount": "sample string 9"
  },
  "fromUser": {
    "activationAccessCode": "sample string 1",
    "company": "sample string 2",
    "connectConfigurations": [
      {
        "configurationtype": "sample string 1",
        "connectId": "sample string 2",
        "enabled": "sample string 3",
        "hasAccess": "sample string 4",
        "senderSearchableItems": [
          "sample string 1"
        ]
      }
    ],
    "countryCode": "sample string 3",
    "createdDateTime": "sample string 4",
    "customSettings": [
      {
        "name": "sample string 1",
        "originalValue": "sample string 2",
        "value": "sample string 3"
      }
    ],
    "defaultAccountId": "sample string 5",
    "email": "sample string 6",
    "enableConnectForUser": "sample string 7",
    "firstName": "sample string 8",
    "forgottenPasswordInfo": {
      "forgottenPasswordAnswer1": "sample string 1",
      "forgottenPasswordAnswer2": "sample string 2",
      "forgottenPasswordAnswer3": "sample string 3",
      "forgottenPasswordAnswer4": "sample string 4",
      "forgottenPasswordQuestion1": "sample string 5",
      "forgottenPasswordQuestion2": "sample string 6",
      "forgottenPasswordQuestion3": "sample string 7",
      "forgottenPasswordQuestion4": "sample string 8"
    },
    "groupList": [
      {}
    ],
    "hasRemoteNotary": true,
    "homeAddress": {
      "address1": "sample string 1",
      "address2": "sample string 2",
      "city": "sample string 3",
      "country": "sample string 4",
      "fax": "sample string 5",
      "phone": "sample string 6",
      "postalCode": "sample string 7",
      "stateOrProvince": "sample string 8",
      "zipPlus4": "sample string 9"
    },
    "initialsImageUri": "sample string 9",
    "isAdmin": "sample string 10",
    "isAlternateAdmin": "sample string 11",
    "isManagedByScim": "sample string 12",
    "isMembershipManagedByScim": "sample string 13",
    "isNAREnabled": "sample string 14",
    "jobTitle": "sample string 15",
    "lastLogin": "sample string 16",
    "lastName": "sample string 17",
    "licenseStatus": "sample string 18",
    "licenseType": "sample string 19",
    "licenseTypes": [
      "sample string 1"
    ],
    "loginStatus": "sample string 20",
    "middleName": "sample string 21",
    "password": "sample string 22",
    "passwordExpiration": "sample string 23",
    "permissionProfileId": "sample string 24",
    "permissionProfileName": "sample string 25",
    "profileImageUri": "sample string 26",
    "sendActivationEmail": "sample string 27",
    "sendActivationOnInvalidLogin": "sample string 28",
    "signatureImageUri": "sample string 29",
    "subscribe": "sample string 30",
    "suffixName": "sample string 31",
    "title": "sample string 32",
    "uri": "sample string 33",
    "userAddedToAccountDateTime": "sample string 34",
    "userId": "sample string 35",
    "userName": "sample string 36",
    "userProfileLastModifiedDate": "sample string 37",
    "userSettings": {
      "accountAgreementsAccessType": "sample string 1",
      "accountAgreementsAccessTypeMetadata": {
        "is21CFRPart11": "sample string 1",
        "options": [
          "sample string 1"
        ],
        "rights": "sample string 2",
        "uiHint": "sample string 3",
        "uiOrder": "sample string 4",
        "uiType": "sample string 5"
      },
      "accountManagementGranular": {
        "canManageAccountSecuritySettings": "sample string 1",
        "canManageAccountSettings": "sample string 2",
        "canManageAdmins": "sample string 3",
        "canManageConnect": "sample string 4",
        "canManageDocumentRetention": "sample string 5",
        "canManageEnvelopeTransfer": "sample string 6",
        "canManageGroupsButNotUsers": "sample string 7",
        "canManageJointAgreements": "sample string 8",
        "canManageReporting": "sample string 9",
        "canManageSharing": "sample string 10",
        "canManageSigningGroups": "sample string 11",
        "canManageStamps": "sample string 12",
        "canManageUsers": "sample string 13",
        "canViewOnlyAccountAdminPages": "sample string 14",
        "canViewUsers": "sample string 15"
      },
      "adminOnly": "sample string 2",
      "allowAccessToAllAccountAgreements": "sample string 3",
      "allowAutoTagging": "sample string 4",
      "allowedDocumentTemplateLibraryAccess": "sample string 5",
      "allowedOrchestrationAccess": "sample string 6",
      "allowEnvelopeTransferTo": "sample string 7",
      "allowEsealRecipients": "sample string 8",
      "allowPowerFormsAdminToAccessAllPowerFormEnvelope": "sample string 9",
      "allowRecipientLanguageSelection": "sample string 10",
      "allowSendOnBehalfOf": "sample string 11",
      "allowSupplementalDocuments": "sample string 12",
      "allowTransactions": "sample string 13",
      "anchorTagVersionedPlacementEnabled": "sample string 14",
      "apiAccountWideAccess": "sample string 15",
      "apiCanExportAC": "sample string 16",
      "bulkSend": "sample string 17",
      "canBulkUploadAgreements": "sample string 18",
      "canChargeAccount": "sample string 19",
      "canCreateTransaction": "sample string 20",
      "canDeleteDocumentsInTransaction": "sample string 21",
      "canDeleteTransaction": "sample string 22",
      "canEditSharedAddressbook": "sample string 23",
      "canLockEnvelopes": "sample string 24",
      "canManageAccount": "sample string 25",
      "canManageAgreementParties": "sample string 26",
      "canManageDistributor": "sample string 27",
      "canManageTemplates": "sample string 28",
      "canSendAPIRequests": "sample string 29",
      "canSendEnvelope": "sample string 30",
      "canSendEnvelopesViaSMS": "sample string 31",
      "canSignEnvelope": "sample string 32",
      "canUseScratchpad": "sample string 33",
      "canUseSmartContracts": "sample string 34",
      "disableDocumentUpload": "sample string 35",
      "disableOtherActions": "sample string 36",
      "enableDSPro": "sample string 37",
      "enableKeyTermsSuggestionsByDocumentType": "sample string 38",
      "enableSequentialSigningAPI": "sample string 39",
      "enableSequentialSigningUI": "sample string 40",
      "enableSignerAttachments": "sample string 41",
      "enableSignOnPaperOverride": "sample string 42",
      "enableTransactionPoint": "sample string 43",
      "enableVaulting": "sample string 44",
      "expressSendOnly": "sample string 45",
      "isManagedByScim": "sample string 46",
      "isMembershipManagedByScim": "sample string 47",
      "isMembershipRedacted": "sample string 48",
      "isUserRedacted": "sample string 49",
      "locale": "sample string 50",
      "localePolicy": {
        "addressFormat": "sample string 1",
        "allowRegion": "sample string 2",
        "calendarType": "sample string 3",
        "cultureName": "sample string 4",
        "currencyCode": "sample string 5",
        "currencyNegativeFormat": "sample string 6",
        "currencyPositiveFormat": "sample string 7",
        "customDateFormat": "sample string 8",
        "customSignDateFormat": "sample string 9",
        "customSignTimeFormat": "sample string 10",
        "customTimeFormat": "sample string 11",
        "dateFormat": "sample string 12",
        "effectiveAddressFormat": "sample string 13",
        "effectiveCalendarType": "sample string 14",
        "effectiveCurrencyCode": "sample string 15",
        "effectiveCurrencyNegativeFormat": "sample string 16",
        "effectiveCurrencyPositiveFormat": "sample string 17",
        "effectiveCustomDateFormat": "sample string 18",
        "effectiveCustomTimeFormat": "sample string 19",
        "effectiveDateFormat": "sample string 20",
        "effectiveInitialFormat": "sample string 21",
        "effectiveNameFormat": "sample string 22",
        "effectiveTimeFormat": "sample string 23",
        "effectiveTimeZone": "sample string 24",
        "initialFormat": "sample string 25",
        "nameFormat": "sample string 26",
        "signDateFormat": "sample string 27",
        "signTimeFormat": "sample string 28",
        "timeFormat": "sample string 29",
        "timeZone": "sample string 30"
      },
      "manageClickwrapsMode": "sample string 51",
      "modifiedBy": "sample string 52",
      "modifiedDate": "sample string 53",
      "modifiedPage": "sample string 54",
      "newSendUI": "sample string 55",
      "powerFormMode": "sample string 56",
      "recipientViewedNotification": "sample string 57",
      "redactMembershipAt": "sample string 58",
      "sealIdentifiers": [
        {
          "sealDisplayName": "sample string 1",
          "sealName": "sample string 2"
        }
      ],
      "selfSignedRecipientEmailDocument": "sample string 59",
      "senderEmailNotifications": {
        "changedSigner": "sample string 1",
        "clickwrapResponsesLimitNotificationEmail": "sample string 2",
        "commentsOnlyPrivateAndMention": "sample string 3",
        "commentsReceiveAll": "sample string 4",
        "deliveryFailed": "sample string 5",
        "envelopeComplete": "sample string 6",
        "offlineSigningFailed": "sample string 7",
        "powerformResponsesLimitNotificationEmail": "sample string 8",
        "purgeDocuments": "sample string 9",
        "recipientViewed": "sample string 10",
        "senderEnvelopeDeclined": "sample string 11",
        "withdrawnConsent": "sample string 12"
      },
      "signerEmailNotifications": {
        "agentNotification": "sample string 1",
        "carbonCopyNotification": "sample string 2",
        "certifiedDeliveryNotification": "sample string 3",
        "commentsOnlyPrivateAndMention": "sample string 4",
        "commentsReceiveAll": "sample string 5",
        "documentMarkupActivation": "sample string 6",
        "envelopeActivation": "sample string 7",
        "envelopeComplete": "sample string 8",
        "envelopeCorrected": "sample string 9",
        "envelopeDeclined": "sample string 10",
        "envelopeVoided": "sample string 11",
        "faxReceived": "sample string 12",
        "offlineSigningFailed": "sample string 13",
        "purgeDocuments": "sample string 14",
        "reassignedSigner": "sample string 15",
        "whenSigningGroupMember": "sample string 16"
      },
      "supplementalDocumentIncludeInDownload": "sample string 60",
      "supplementalDocumentsMustAccept": "sample string 61",
      "supplementalDocumentsMustRead": "sample string 62",
      "supplementalDocumentsMustView": "sample string 63",
      "templateActiveCreation": "sample string 64",
      "templateApplyNotify": "sample string 65",
      "templateAutoMatching": "sample string 66",
      "templateMatchingSensitivity": "sample string 67",
      "templatePageLevelMatching": "sample string 68",
      "timezoneDST": "sample string 69",
      "timezoneMask": "sample string 70",
      "timezoneOffset": "sample string 71",
      "timezoneSendingPref": "sample string 72",
      "timezoneSigningPref": "sample string 73",
      "transactionPointSiteNameURL": "sample string 74",
      "transactionPointUserName": "sample string 75",
      "vaultingMode": "sample string 76",
      "webForms": "sample string 77"
    },
    "userStatus": "sample string 38",
    "userType": "sample string 39"
  },
  "modifiedDate": "sample string 5",
  "toFolder": {
    "filter": {
      "actionRequired": "sample string 1",
      "expires": "sample string 2",
      "folderIds": "sample string 3",
      "fromDateTime": "sample string 4",
      "isTemplate": "sample string 5",
      "order": "sample string 6",
      "orderBy": "sample string 7",
      "searchTarget": "sample string 8",
      "searchText": "sample string 9",
      "status": "sample string 10",
      "toDateTime": "sample string 11"
    },
    "folderId": "sample string 1",
    "folderItems": [
      {
        "completedDateTime": "sample string 1",
        "createdDateTime": "sample string 2",
        "envelopeId": "sample string 3",
        "envelopeUri": "sample string 4",
        "expireDateTime": "sample string 5",
        "folderId": "sample string 6",
        "folderUri": "sample string 7",
        "is21CFRPart11": "sample string 8",
        "lastModifiedDateTime": "sample string 9",
        "ownerName": "sample string 10",
        "recipients": {
          "agents": [
            {}
          ],
          "authorizedSignatories": [
            {}
          ],
          "carbonCopies": [
            {}
          ],
          "certifiedDeliveries": [
            {}
          ],
          "currentRoutingOrder": "sample string 1",
          "editors": [
            {}
          ],
          "inPersonSigners": [
            {}
          ],
          "intermediaries": [
            {}
          ],
          "notaries": [
            {}
          ],
          "notaryWitnesses": [
            {}
          ],
          "participants": [
            {}
          ],
          "recipientCount": "sample string 2",
          "seals": [
            {}
          ],
          "signers": [
            {}
          ],
          "witnesses": [
            {}
          ]
        },
        "recipientsUri": "sample string 11",
        "senderCompany": "sample string 12",
        "senderEmail": "sample string 13",
        "senderName": "sample string 14",
        "senderUserId": "sample string 15",
        "sentDateTime": "sample string 16",
        "status": "sample string 17",
        "subject": "sample string 18",
        "templateId": "sample string 19",
        "templateUri": "sample string 20"
      }
    ],
    "folders": [
      {}
    ],
    "hasAccess": "sample string 2",
    "hasSubFolders": "sample string 3",
    "itemCount": "sample string 4",
    "name": "sample string 5",
    "parentFolderId": "sample string 6",
    "parentFolderUri": "sample string 7",
    "subFolderCount": "sample string 8",
    "type": "sample string 9",
    "uri": "sample string 10"
  }
}

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.

Authentication

AuthorizationBearer

OAuth 2.0 access token (JWT or auth-code grant). Sent as Authorization: Bearer <token> on every request except GET /v2.1 and GET /service_information, which are public discovery endpoints.

Path parameters

accountIdstringRequired

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

envelopeTransferRuleIdstringRequired

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

Request

This endpoint expects an object: envelopeTransferRule

carbonCopyOriginalOwnerstringOptional

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

enabledstringOptional

When true, the envelope transfer rule is active.

envelopeTransferRuleIdstringOptional

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

eventTypestringOptional

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

sent
beforeSent
completed

fromGroupobjectOptional

This object contains information about a group.

fromUserobjectOptional

User information.

modifiedDatestringOptional

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

modifiedUserobjectOptional

User information.

toFolderobjectOptional

This object contains details about a folder.

toUserobjectOptional

User information.

Response

Successful response.

carbonCopyOriginalOwnerstringOptional

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

enabledstringOptional

When true, the envelope transfer rule is active.

envelopeTransferRuleIdstringOptional

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

eventTypestringOptional

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

sent
beforeSent
completed

fromGroupobjectOptional

This object contains information about a group.

fromUserobjectOptional

User information.

modifiedDatestringOptional

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

modifiedUserobjectOptional

User information.

toFolderobjectOptional

This object contains details about a folder.

toUserobjectOptional

User information.

Errors

400

Bad Request Error