SQL Server / DocuSign eSignature REST API / Updates a specified Connect configuration.
Back to Collection Items
-- Important: See this note about string length limitations for strings returned by sp_OAMethod calls.
--
CREATE PROCEDURE ChilkatSample
AS
BEGIN
DECLARE @hr int
DECLARE @iTmp0 int
-- Important: Do not use nvarchar(max). See the warning about using nvarchar(max).
DECLARE @sTmp0 nvarchar(4000)
-- This example assumes the Chilkat API to have been previously unlocked.
-- See Global Unlock Sample for sample code.
DECLARE @http int
-- Use "Chilkat_9_5_0.Http" for versions of Chilkat < 10.0.0
EXEC @hr = sp_OACreate 'Chilkat.Http', @http OUT
IF @hr <> 0
BEGIN
PRINT 'Failed to create ActiveX component'
RETURN
END
DECLARE @success int
-- Use this online tool to generate code from sample JSON: Generate Code to Create JSON
-- The following JSON is sent in the request body.
-- {
-- "connectId": "sample string 1",
-- "configurationType": "sample string 2",
-- "urlToPublishTo": "sample string 3",
-- "name": "sample string 4",
-- "allowEnvelopePublish": "sample string 5",
-- "enableLog": "sample string 6",
-- "includeDocuments": "sample string 7",
-- "includeCertificateOfCompletion": "sample string 8",
-- "requiresAcknowledgement": "sample string 9",
-- "signMessageWithX509Certificate": "sample string 10",
-- "useSoapInterface": "sample string 11",
-- "includeTimeZoneInformation": "sample string 12",
-- "includeHMAC": "sample string 13",
-- "includeEnvelopeVoidReason": "sample string 14",
-- "includeSenderAccountasCustomField": "sample string 15",
-- "envelopeEvents": "sample string 16",
-- "recipientEvents": "sample string 17",
-- "userIds": "sample string 18",
-- "soapNamespace": "sample string 19",
-- "allUsers": "sample string 20",
-- "includeCertSoapHeader": "sample string 21",
-- "includeDocumentFields": "sample string 22"
-- }
DECLARE @json int
-- Use "Chilkat_9_5_0.JsonObject" for versions of Chilkat < 10.0.0
EXEC @hr = sp_OACreate 'Chilkat.JsonObject', @json OUT
EXEC sp_OAMethod @json, 'UpdateString', @success OUT, 'connectId', 'sample string 1'
EXEC sp_OAMethod @json, 'UpdateString', @success OUT, 'configurationType', 'sample string 2'
EXEC sp_OAMethod @json, 'UpdateString', @success OUT, 'urlToPublishTo', 'sample string 3'
EXEC sp_OAMethod @json, 'UpdateString', @success OUT, 'name', 'sample string 4'
EXEC sp_OAMethod @json, 'UpdateString', @success OUT, 'allowEnvelopePublish', 'sample string 5'
EXEC sp_OAMethod @json, 'UpdateString', @success OUT, 'enableLog', 'sample string 6'
EXEC sp_OAMethod @json, 'UpdateString', @success OUT, 'includeDocuments', 'sample string 7'
EXEC sp_OAMethod @json, 'UpdateString', @success OUT, 'includeCertificateOfCompletion', 'sample string 8'
EXEC sp_OAMethod @json, 'UpdateString', @success OUT, 'requiresAcknowledgement', 'sample string 9'
EXEC sp_OAMethod @json, 'UpdateString', @success OUT, 'signMessageWithX509Certificate', 'sample string 10'
EXEC sp_OAMethod @json, 'UpdateString', @success OUT, 'useSoapInterface', 'sample string 11'
EXEC sp_OAMethod @json, 'UpdateString', @success OUT, 'includeTimeZoneInformation', 'sample string 12'
EXEC sp_OAMethod @json, 'UpdateString', @success OUT, 'includeHMAC', 'sample string 13'
EXEC sp_OAMethod @json, 'UpdateString', @success OUT, 'includeEnvelopeVoidReason', 'sample string 14'
EXEC sp_OAMethod @json, 'UpdateString', @success OUT, 'includeSenderAccountasCustomField', 'sample string 15'
EXEC sp_OAMethod @json, 'UpdateString', @success OUT, 'envelopeEvents', 'sample string 16'
EXEC sp_OAMethod @json, 'UpdateString', @success OUT, 'recipientEvents', 'sample string 17'
EXEC sp_OAMethod @json, 'UpdateString', @success OUT, 'userIds', 'sample string 18'
EXEC sp_OAMethod @json, 'UpdateString', @success OUT, 'soapNamespace', 'sample string 19'
EXEC sp_OAMethod @json, 'UpdateString', @success OUT, 'allUsers', 'sample string 20'
EXEC sp_OAMethod @json, 'UpdateString', @success OUT, 'includeCertSoapHeader', 'sample string 21'
EXEC sp_OAMethod @json, 'UpdateString', @success OUT, 'includeDocumentFields', 'sample string 22'
-- Adds the "Authorization: Bearer {{accessToken}}" header.
EXEC sp_OASetProperty @http, 'AuthToken', '{{accessToken}}'
EXEC sp_OAMethod @http, 'SetRequestHeader', NULL, 'Accept', 'application/json'
DECLARE @sbRequestBody int
-- Use "Chilkat_9_5_0.StringBuilder" for versions of Chilkat < 10.0.0
EXEC @hr = sp_OACreate 'Chilkat.StringBuilder', @sbRequestBody OUT
EXEC sp_OAMethod @json, 'EmitSb', @success OUT, @sbRequestBody
DECLARE @resp int
EXEC sp_OAMethod @http, 'PTextSb', @resp OUT, 'PUT', 'https://domain.com/v2.1/accounts/{{accountId}}/connect', @sbRequestBody, 'utf-8', 'application/json', 0, 0
EXEC sp_OAGetProperty @http, 'LastMethodSuccess', @iTmp0 OUT
IF @iTmp0 = 0
BEGIN
EXEC sp_OAGetProperty @http, 'LastErrorText', @sTmp0 OUT
PRINT @sTmp0
EXEC @hr = sp_OADestroy @http
EXEC @hr = sp_OADestroy @json
EXEC @hr = sp_OADestroy @sbRequestBody
RETURN
END
EXEC sp_OAGetProperty @resp, 'StatusCode', @iTmp0 OUT
PRINT @iTmp0
EXEC sp_OAGetProperty @resp, 'BodyStr', @sTmp0 OUT
PRINT @sTmp0
EXEC @hr = sp_OADestroy @resp
EXEC @hr = sp_OADestroy @http
EXEC @hr = sp_OADestroy @json
EXEC @hr = sp_OADestroy @sbRequestBody
END
GO
Curl Command
curl -X PUT
-H "Accept: application/json"
-H "Authorization: Bearer {{accessToken}}"
-d '{
"connectId": "sample string 1",
"configurationType": "sample string 2",
"urlToPublishTo": "sample string 3",
"name": "sample string 4",
"allowEnvelopePublish": "sample string 5",
"enableLog": "sample string 6",
"includeDocuments": "sample string 7",
"includeCertificateOfCompletion": "sample string 8",
"requiresAcknowledgement": "sample string 9",
"signMessageWithX509Certificate": "sample string 10",
"useSoapInterface": "sample string 11",
"includeTimeZoneInformation": "sample string 12",
"includeHMAC": "sample string 13",
"includeEnvelopeVoidReason": "sample string 14",
"includeSenderAccountasCustomField": "sample string 15",
"envelopeEvents": "sample string 16",
"recipientEvents": "sample string 17",
"userIds": "sample string 18",
"soapNamespace": "sample string 19",
"allUsers": "sample string 20",
"includeCertSoapHeader": "sample string 21",
"includeDocumentFields": "sample string 22"
}'
https://domain.com/v2.1/accounts/{{accountId}}/connect
Postman Collection Item JSON
{
"name": "Updates a specified Connect configuration.",
"request": {
"method": "PUT",
"header": [
{
"key": "Accept",
"value": "application/json"
},
{
"key": "Authorization",
"value": "Bearer {{accessToken}}"
}
],
"body": {
"mode": "raw",
"raw": "{\n \"connectId\": \"sample string 1\",\n \"configurationType\": \"sample string 2\",\n \"urlToPublishTo\": \"sample string 3\",\n \"name\": \"sample string 4\",\n \"allowEnvelopePublish\": \"sample string 5\",\n \"enableLog\": \"sample string 6\",\n \"includeDocuments\": \"sample string 7\",\n \"includeCertificateOfCompletion\": \"sample string 8\",\n \"requiresAcknowledgement\": \"sample string 9\",\n \"signMessageWithX509Certificate\": \"sample string 10\",\n \"useSoapInterface\": \"sample string 11\",\n \"includeTimeZoneInformation\": \"sample string 12\",\n \"includeHMAC\": \"sample string 13\",\n \"includeEnvelopeVoidReason\": \"sample string 14\",\n \"includeSenderAccountasCustomField\": \"sample string 15\",\n \"envelopeEvents\": \"sample string 16\",\n \"recipientEvents\": \"sample string 17\",\n \"userIds\": \"sample string 18\",\n \"soapNamespace\": \"sample string 19\",\n \"allUsers\": \"sample string 20\",\n \"includeCertSoapHeader\": \"sample string 21\",\n \"includeDocumentFields\": \"sample string 22\"\n}"
},
"url": {
"raw": "{{baseUrl}}/v2.1/accounts/{{accountId}}/connect",
"host": [
"{{baseUrl}}"
],
"path": [
"v2.1",
"accounts",
"{{accountId}}",
"connect"
],
"variable": [
{
"key": "accountId",
"value": "{{accountId}}",
"type": "string"
}
]
},
"description": "Updates the specified DocuSign Connect configuration in your account.\n\n###### Note: Connect must be enabled for your account to use this function. This cannot be used to update Connect configurations for Box, eOriginal, or Salesforce."
},
"response": [
]
}
