Own DocuSign? Customize your docs with AI search, analytics, and more.

PUT

Changes the status of an envelope transfer rule.

https://www.docusign.com/v2.1/accounts/{accountId}/envelopes/transfer_rules/{envelopeTransferRuleId}

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.

Access Token Required: API Key

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.

Responses

{
  "success": true,
  "data": {
    "id": "abc123",
    "created_at": "2025-01-01T00:00:00Z"
  }
}

{
  "success": false,
  "error": {
    "code": "VALIDATION_ERROR",
    "message": "Invalid request parameters"
  }
}

Language

CredentialsAPI KEY

API Key

Enter token below to save for later

cURL Request

1curl --request PUT \
2     --url 'https://www.docusign.com/v2.1/accounts/{accountId}/envelopes/transfer_rules/{envelopeTransferRuleId}' \
3     --header 'accept: application/json' \
4     --header 'content-type: application/json'

Response

1{
2  "success": true,
3  "data": {
4    "id": "abc123",
5    "created_at": "2025-01-01T00:00:00Z"
6  }
7}

PUT

Changes the status of an envelope transfer rule.

https://www.docusign.com/v2.1/accounts/{accountId}/envelopes/transfer_rules/{envelopeTransferRuleId}

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.

Access Token Required: API Key

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.

Responses

{
  "success": true,
  "data": {
    "id": "abc123",
    "created_at": "2025-01-01T00:00:00Z"
  }
}

{
  "success": false,
  "error": {
    "code": "VALIDATION_ERROR",
    "message": "Invalid request parameters"
  }
}

Language

CredentialsAPI KEY

API Key

Enter token below to save for later

cURL Request

1curl --request PUT \
2     --url 'https://www.docusign.com/v2.1/accounts/{accountId}/envelopes/transfer_rules/{envelopeTransferRuleId}' \
3     --header 'accept: application/json' \
4     --header 'content-type: application/json'

Response

1{
2  "success": true,
3  "data": {
4    "id": "abc123",
5    "created_at": "2025-01-01T00:00:00Z"
6  }
7}

PUT

Changes the status of an envelope transfer rule.

https://www.docusign.com/v2.1/accounts/{accountId}/envelopes/transfer_rules/{envelopeTransferRuleId}

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.

Access Token Required: API Key

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.

Responses

{
  "success": true,
  "data": {
    "id": "abc123",
    "created_at": "2025-01-01T00:00:00Z"
  }
}

{
  "success": false,
  "error": {
    "code": "VALIDATION_ERROR",
    "message": "Invalid request parameters"
  }
}

Language

CredentialsAPI KEY

API Key

Enter token below to save for later

cURL Request

1curl --request PUT \
2     --url 'https://www.docusign.com/v2.1/accounts/{accountId}/envelopes/transfer_rules/{envelopeTransferRuleId}' \
3     --header 'accept: application/json' \
4     --header 'content-type: application/json'

Response

1{
2  "success": true,
3  "data": {
4    "id": "abc123",
5    "created_at": "2025-01-01T00:00:00Z"
6  }
7}

PUT

Changes the status of an envelope transfer rule.

https://www.docusign.com/v2.1/accounts/{accountId}/envelopes/transfer_rules/{envelopeTransferRuleId}

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.

Access Token Required: API Key

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.

Responses

{
  "success": true,
  "data": {
    "id": "abc123",
    "created_at": "2025-01-01T00:00:00Z"
  }
}

{
  "success": false,
  "error": {
    "code": "VALIDATION_ERROR",
    "message": "Invalid request parameters"
  }
}

Language

CredentialsAPI KEY

API Key

Enter token below to save for later

cURL Request

1curl --request PUT \
2     --url 'https://www.docusign.com/v2.1/accounts/{accountId}/envelopes/transfer_rules/{envelopeTransferRuleId}' \
3     --header 'accept: application/json' \
4     --header 'content-type: application/json'

Response

1{
2  "success": true,
3  "data": {
4    "id": "abc123",
5    "created_at": "2025-01-01T00:00:00Z"
6  }
7}