Request

HTTP request

PUT /v2/accounts/{accountId}/consumer_disclosure/{langCode}

Parameters

Parameter name Value Description
Path parameters
accountId string

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

langCode string

The simple type enumeration the language used in the response. The supported languages, with the language value shown in parenthesis, are:Arabic (ar), Bulgarian (bg), Czech (cs), Chinese Simplified (zh_CN), Chinese Traditional (zh_TW), Croatian (hr), Danish (da), Dutch (nl), English US (en), English UK (en_GB), Estonian (et), Farsi (fa), Finnish (fi), French (fr), French Canada (fr_CA), German (de), Greek (el), Hebrew (he), Hindi (hi), Hungarian (hu), Bahasa Indonesia (id), Italian (it), Japanese (ja), Korean (ko), Latvian (lv), Lithuanian (lt), Bahasa Melayu (ms), Norwegian (no), Polish (pl), Portuguese (pt), Portuguese Brazil (pt_BR), Romanian (ro), Russian (ru), Serbian (sr), Slovak (sk), Slovenian (sl), Spanish (es),Spanish Latin America (es_MX), Swedish (sv), Thai (th), Turkish (tr), Ukrainian (uk) and Vietnamese (vi). Additionally, the value can be set to "browser" to automatically detect the browser language being used by the viewer and display the disclosure in that language.

Optional query parameters
include_metadata string

Reserved for DocuSign.

Responses

Code Description Reference
200 OK Successful response.
400 Bad Request Error encountered.

SDK Method

Accounts::updateConsumerDisclosure

Definitions Expand All | Collapse All

EnvelopeConsumerDisclosures

Envelope consumer disclosures

accountEsignId string

A GUID identifying the account associated with the consumer disclosure

allowCDWithdraw string

Indicates whether the customer can withdraw their acceptance of the consumer disclosure.

allowCDWithdrawMetadata settingsMetadata
changeEmail string
changeEmailOther string
companyName string

The name of the company associated with the consumer disclosure.

companyPhone string

The phone number of the company associated with the consumer disclosure.

copyCostPerPage string
copyFeeCollectionMethod string

Specifies the fee collection method for cases in which the customer requires paper copies of the document.

Maximum Length: 255 characters

copyRequestEmail string
custom string
enableEsign string
esignAgreement string

The Electronic Record and Signature Disclosure text. The disclosure text includes the html formatting.

esignText string
languageCode string
mustAgreeToEsign string
pdfId string
useBrand string
useConsumerDisclosureWithinAccount string
useConsumerDisclosureWithinAccountMetadata settingsMetadata
withdrawAddressLine1 string

Contains the first address line of the postal address to which a customer can send a consent withdrawal notification.

Maximum length: 100 characters.

withdrawAddressLine2 string

Contains the second address line of the postal address to which a customer can send a consent withdrawal notification.

Maximum length: 100 characters.

withdrawByEmail string

Indicates whether the customer can withdraw consent by email.

withdrawByMail string

Indicates whether the customer can withdraw consent by postal mail.

withdrawByPhone string

Indicates whether the customer can withdraw consent by phone.

withdrawCity string

Contains the city of the postal address to which a customer can send a consent withdrawal notification.

Maximum length: 50 characters.

withdrawConsequences string

Indicates the consequences of withdrawing consent.

withdrawEmail string

Contains the email address to which a customer can send a consent withdrawal notification.

Maximum length: 100 characters.

withdrawOther string

Indicates other information need to withdraw consent.

Maximum length: 255 characters.

withdrawPhone string

Contains the phone number which a customer can call to register consent withdrawal notification.

Maximum length: 20 characters.

withdrawPostalCode string

Contains the postal code of the postal address to which a customer can send a consent withdrawal notification.

Maximum length: 20 characters.

withdrawState string

Contains the state of the postal address to which a customer can send a consent withdrawal notification.

errorDetails

This object describes errors that occur. It is only valid for responses, and ignored in requests.

errorCode string

An error code associated with the error.

message string

A short error message.

settingsMetadata

is21CFRPart11 string

When set to true, indicates that this module is enabled on the account.

options
[string]
rights string
uiHint string
uiOrder string
uiType string

Examples

Generic JSON Request/Response

Request

{
"companyName": "sample string 1",
"companyPhone": "sample string 2",
"withdrawEmail": "sample string 3",
"withdrawByEmail": "sample string 4",
"withdrawByPhone": "sample string 5",
"withdrawByMail": "sample string 6",
"withdrawAddressLine1": "sample string 7",
"withdrawAddressLine2": "sample string 8",
"withdrawCity": "sample string 9",
"withdrawState": "sample string 10",
"withdrawPostalCode": "sample string 11",
"withdrawConsequences": "sample string 12",
"withdrawOther": "sample string 13",
"withdrawPhone": "sample string 14",
"changeEmail": "sample string 15",
"changeEmailOther": "sample string 16",
"copyCostPerPage": "sample string 17",
"copyRequestEmail": "sample string 18",
"copyFeeCollectionMethod": "sample string 19",
"custom": "sample string 20",
"pdfId": "sample string 21",
"enableEsign": "sample string 22",
"useBrand": "sample string 23",
"esignAgreement": "sample string 24",
"esignText": "sample string 25",
"allowCDWithdraw": "sample string 26",
"mustAgreeToEsign": "sample string 27",
"useConsumerDisclosureWithinAccount": "sample string 28"
}

Response

{
"accountEsignId": "sample string 1",
"companyName": "sample string 2",
"companyPhone": "sample string 3",
"withdrawEmail": "sample string 4",
"withdrawByEmail": "sample string 5",
"withdrawByPhone": "sample string 6",
"withdrawByMail": "sample string 7",
"withdrawAddressLine1": "sample string 8",
"withdrawAddressLine2": "sample string 9",
"withdrawCity": "sample string 10",
"withdrawState": "sample string 11",
"withdrawPostalCode": "sample string 12",
"withdrawConsequences": "sample string 13",
"withdrawOther": "sample string 14",
"withdrawPhone": "sample string 15",
"changeEmail": "sample string 16",
"changeEmailOther": "sample string 17",
"copyCostPerPage": "sample string 18",
"copyRequestEmail": "sample string 19",
"copyFeeCollectionMethod": "sample string 20",
"custom": "sample string 21",
"pdfId": "sample string 22",
"enableEsign": "sample string 23",
"languageCode": "sample string 24",
"useBrand": "sample string 25",
"esignAgreement": "sample string 26",
"esignText": "sample string 27",
"allowCDWithdraw": "sample string 28",
"allowCDWithdrawMetadata": {
"rights": "sample string 1",
"uiHint": "sample string 2",
"uiType": "sample string 3",
"uiOrder": "sample string 4",
"is21CFRPart11": "sample string 5",
"options": [
"sample string 1"
]
}
,
"mustAgreeToEsign": "sample string 29",
"useConsumerDisclosureWithinAccount": "sample string 30",
"useConsumerDisclosureWithinAccountMetadata": {}
}

Generic XML Request/Response

Request

<consumerDisclosure 
xmlns:i="http://www.w3.org/2001/XMLSchema-instance"
xmlns="http://www.docusign.com/restapi">

<allowCDWithdraw>sample string 26</allowCDWithdraw>
<changeEmail>sample string 15</changeEmail>
<changeEmailOther>sample string 16</changeEmailOther>
<companyName>sample string 1</companyName>
<companyPhone>sample string 2</companyPhone>
<copyCostPerPage>sample string 17</copyCostPerPage>
<copyFeeCollectionMethod>sample string 19</copyFeeCollectionMethod>
<copyRequestEmail>sample string 18</copyRequestEmail>
<custom>sample string 20</custom>
<enableEsign>sample string 22</enableEsign>
<esignAgreement>sample string 24</esignAgreement>
<esignText>sample string 25</esignText>
<mustAgreeToEsign>sample string 27</mustAgreeToEsign>
<pdfId>sample string 21</pdfId>
<useBrand>sample string 23</useBrand>
<useConsumerDisclosureWithinAccount>sample string 28</useConsumerDisclosureWithinAccount>
<withdrawAddressLine1>sample string 7</withdrawAddressLine1>
<withdrawAddressLine2>sample string 8</withdrawAddressLine2>
<withdrawByEmail>sample string 4</withdrawByEmail>
<withdrawByMail>sample string 6</withdrawByMail>
<withdrawByPhone>sample string 5</withdrawByPhone>
<withdrawCity>sample string 9</withdrawCity>
<withdrawConsequences>sample string 12</withdrawConsequences>
<withdrawEmail>sample string 3</withdrawEmail>
<withdrawOther>sample string 13</withdrawOther>
<withdrawPhone>sample string 14</withdrawPhone>
<withdrawPostalCode>sample string 11</withdrawPostalCode>
<withdrawState>sample string 10</withdrawState>
</consumerDisclosure>

Response

<consumerDisclosure 
xmlns:i="http://www.w3.org/2001/XMLSchema-instance"
xmlns="http://www.docusign.com/restapi">

<accountEsignId>sample string 1</accountEsignId>
<allowCDWithdraw>sample string 28</allowCDWithdraw>
<allowCDWithdrawMetadata>
<is21CFRPart11>sample string 5</is21CFRPart11>
<options>
<string>sample string 1</string>
</options>
<rights>sample string 1</rights>
<uiHint>sample string 2</uiHint>
<uiOrder>sample string 4</uiOrder>
<uiType>sample string 3</uiType>
</allowCDWithdrawMetadata>
<changeEmail>sample string 16</changeEmail>
<changeEmailOther>sample string 17</changeEmailOther>
<companyName>sample string 2</companyName>
<companyPhone>sample string 3</companyPhone>
<copyCostPerPage>sample string 18</copyCostPerPage>
<copyFeeCollectionMethod>sample string 20</copyFeeCollectionMethod>
<copyRequestEmail>sample string 19</copyRequestEmail>
<custom>sample string 21</custom>
<enableEsign>sample string 23</enableEsign>
<esignAgreement>sample string 26</esignAgreement>
<esignText>sample string 27</esignText>
<languageCode>sample string 24</languageCode>
<mustAgreeToEsign>sample string 29</mustAgreeToEsign>
<pdfId>sample string 22</pdfId>
<useBrand>sample string 25</useBrand>
<useConsumerDisclosureWithinAccount>sample string 30</useConsumerDisclosureWithinAccount>
<useConsumerDisclosureWithinAccountMetadata />
<withdrawAddressLine1>sample string 8</withdrawAddressLine1>
<withdrawAddressLine2>sample string 9</withdrawAddressLine2>
<withdrawByEmail>sample string 5</withdrawByEmail>
<withdrawByMail>sample string 7</withdrawByMail>
<withdrawByPhone>sample string 6</withdrawByPhone>
<withdrawCity>sample string 10</withdrawCity>
<withdrawConsequences>sample string 13</withdrawConsequences>
<withdrawEmail>sample string 4</withdrawEmail>
<withdrawOther>sample string 14</withdrawOther>
<withdrawPhone>sample string 15</withdrawPhone>
<withdrawPostalCode>sample string 12</withdrawPostalCode>
<withdrawState>sample string 11</withdrawState>
</consumerDisclosure>