Chilkat Online Tools

TCL / DocuSign REST API / Updates the email setting overrides for an envelope.

Back to Collection Items

load ./chilkat.dll

# This example assumes the Chilkat API to have been previously unlocked.
# See Global Unlock Sample for sample code.

set http [new_CkHttp]

# Use this online tool to generate code from sample JSON: Generate Code to Create JSON

# The following JSON is sent in the request body.

# {
#   "replyEmailAddressOverride": "sample string 1",
#   "replyEmailNameOverride": "sample string 2",
#   "bccEmailAddresses": [
#     {
#       "bccEmailAddressId": "sample string 1",
#       "email": "sample string 2"
#     }
#   ]
# }

set json [new_CkJsonObject]

CkJsonObject_UpdateString $json "replyEmailAddressOverride" "sample string 1"
CkJsonObject_UpdateString $json "replyEmailNameOverride" "sample string 2"
CkJsonObject_UpdateString $json "bccEmailAddresses[0].bccEmailAddressId" "sample string 1"
CkJsonObject_UpdateString $json "bccEmailAddresses[0].email" "sample string 2"

# Adds the "Authorization: Bearer {{accessToken}}" header.
CkHttp_put_AuthToken $http "{{accessToken}}"
CkHttp_SetRequestHeader $http "Accept" "application/json"

set sbRequestBody [new_CkStringBuilder]

CkJsonObject_EmitSb $json $sbRequestBody

# resp is a CkHttpResponse
set resp [CkHttp_PTextSb $http "PUT" "https://domain.com/v2.1/accounts/{{accountId}}/envelopes/{{envelopeId}}/email_settings" $sbRequestBody "utf-8" "application/json" 0 0]
if {[CkHttp_get_LastMethodSuccess $http] == 0} then {
    puts [CkHttp_lastErrorText $http]
    delete_CkHttp $http
    delete_CkJsonObject $json
    delete_CkStringBuilder $sbRequestBody
    exit
}

puts [CkHttpResponse_get_StatusCode $resp]
puts [CkHttpResponse_bodyStr $resp]
delete_CkHttpResponse $resp


delete_CkHttp $http
delete_CkJsonObject $json
delete_CkStringBuilder $sbRequestBody

Curl Command

curl -X PUT
	-H "Accept: application/json"
	-H "Authorization: Bearer {{accessToken}}"
	-d '{
  "replyEmailAddressOverride": "sample string 1",
  "replyEmailNameOverride": "sample string 2",
  "bccEmailAddresses": [
    {
      "bccEmailAddressId": "sample string 1",
      "email": "sample string 2"
    }
  ]
}'
https://domain.com/v2.1/accounts/{{accountId}}/envelopes/{{envelopeId}}/email_settings

Postman Collection Item JSON

{
  "name": "Updates the email setting overrides for an envelope.",
  "request": {
    "method": "PUT",
    "header": [
      {
        "key": "Accept",
        "value": "application/json"
      },
      {
        "key": "Authorization",
        "value": "Bearer {{accessToken}}"
      }
    ],
    "body": {
      "mode": "raw",
      "raw": "{\n  \"replyEmailAddressOverride\": \"sample string 1\",\n  \"replyEmailNameOverride\": \"sample string 2\",\n  \"bccEmailAddresses\": [\n    {\n      \"bccEmailAddressId\": \"sample string 1\",\n      \"email\": \"sample string 2\"\n    }\n  ]\n}"
    },
    "url": {
      "raw": "{{baseUrl}}/v2.1/accounts/{{accountId}}/envelopes/{{envelopeId}}/email_settings",
      "host": [
        "{{baseUrl}}"
      ],
      "path": [
        "v2.1",
        "accounts",
        "{{accountId}}",
        "envelopes",
        "{{envelopeId}}",
        "email_settings"
      ],
      "variable": [
        {
          "key": "accountId",
          "value": "{{accountId}}"
        },
        {
          "key": "envelopeId",
          "value": "{{envelopeId}}"
        }
      ]
    },
    "description": "Updates the existing email override settings for the specified envelope. Note that modifying email settings will only affect email communications that occur after the modification was made.\n\nThis can also be used to delete an individual email override setting by using an empty string for the value to be deleted."
  },
  "response": [
  ]
}