Android / DocuSign eSignature REST API / Updates envelope custom fields for an envelope.
Back to Collection Items
// Important: Don't forget to include the call to System.loadLibrary
// as shown at the bottom of this code sample.
package com.test;
import android.app.Activity;
import com.chilkatsoft.*;
import android.widget.TextView;
import android.os.Bundle;
public class SimpleActivity extends Activity {
private static final String TAG = "Chilkat";
// Called when the activity is first created.
@Override
public void onCreate(Bundle savedInstanceState) {
super.onCreate(savedInstanceState);
// This example assumes the Chilkat API to have been previously unlocked.
// See Global Unlock Sample for sample code.
CkHttp http = new CkHttp();
boolean success;
// Use this online tool to generate code from sample JSON: Generate Code to Create JSON
// The following JSON is sent in the request body.
// {
// "textCustomFields": [
// {
// "fieldId": "sample string 1",
// "name": "sample string 2",
// "show": "sample string 3",
// "required": "sample string 4",
// "value": "sample string 5",
// "configurationType": "sample string 6"
// }
// ],
// "listCustomFields": [
// {
// "listItems": [
// "sample string 1"
// ],
// "fieldId": "sample string 1",
// "name": "sample string 2",
// "show": "sample string 3",
// "required": "sample string 4",
// "value": "sample string 5",
// "configurationType": "sample string 6"
// }
// ]
// }
CkJsonObject json = new CkJsonObject();
json.UpdateString("textCustomFields[0].fieldId","sample string 1");
json.UpdateString("textCustomFields[0].name","sample string 2");
json.UpdateString("textCustomFields[0].show","sample string 3");
json.UpdateString("textCustomFields[0].required","sample string 4");
json.UpdateString("textCustomFields[0].value","sample string 5");
json.UpdateString("textCustomFields[0].configurationType","sample string 6");
json.UpdateString("listCustomFields[0].listItems[0]","sample string 1");
json.UpdateString("listCustomFields[0].fieldId","sample string 1");
json.UpdateString("listCustomFields[0].name","sample string 2");
json.UpdateString("listCustomFields[0].show","sample string 3");
json.UpdateString("listCustomFields[0].required","sample string 4");
json.UpdateString("listCustomFields[0].value","sample string 5");
json.UpdateString("listCustomFields[0].configurationType","sample string 6");
// Adds the "Authorization: Bearer {{accessToken}}" header.
http.put_AuthToken("{{accessToken}}");
http.SetRequestHeader("Accept","application/json");
CkHttpResponse resp = http.PostJson3("https://domain.com/v2.1/accounts/{{accountId}}/envelopes/{{envelopeId}}/custom_fields","application/json",json);
if (http.get_LastMethodSuccess() == false) {
Log.i(TAG, http.lastErrorText());
return;
}
Log.i(TAG, String.valueOf(resp.get_StatusCode()));
Log.i(TAG, resp.bodyStr());
}
static {
System.loadLibrary("chilkat");
// Note: If the incorrect library name is passed to System.loadLibrary,
// then you will see the following error message at application startup:
//"The application <your-application-name> has stopped unexpectedly. Please try again."
}
}
Curl Command
curl -X POST
-H "Accept: application/json"
-H "Authorization: Bearer {{accessToken}}"
-d '{
"textCustomFields": [
{
"fieldId": "sample string 1",
"name": "sample string 2",
"show": "sample string 3",
"required": "sample string 4",
"value": "sample string 5",
"configurationType": "sample string 6"
}
],
"listCustomFields": [
{
"listItems": [
"sample string 1"
],
"fieldId": "sample string 1",
"name": "sample string 2",
"show": "sample string 3",
"required": "sample string 4",
"value": "sample string 5",
"configurationType": "sample string 6"
}
]
}'
https://domain.com/v2.1/accounts/{{accountId}}/envelopes/{{envelopeId}}/custom_fields
Postman Collection Item JSON
{
"name": "Updates envelope custom fields for an envelope.",
"request": {
"method": "POST",
"header": [
{
"key": "Accept",
"value": "application/json"
},
{
"key": "Authorization",
"value": "Bearer {{accessToken}}"
}
],
"body": {
"mode": "raw",
"raw": "{\n \"textCustomFields\": [\n {\n \"fieldId\": \"sample string 1\",\n \"name\": \"sample string 2\",\n \"show\": \"sample string 3\",\n \"required\": \"sample string 4\",\n \"value\": \"sample string 5\",\n \"configurationType\": \"sample string 6\"\n }\n ],\n \"listCustomFields\": [\n {\n \"listItems\": [\n \"sample string 1\"\n ],\n \"fieldId\": \"sample string 1\",\n \"name\": \"sample string 2\",\n \"show\": \"sample string 3\",\n \"required\": \"sample string 4\",\n \"value\": \"sample string 5\",\n \"configurationType\": \"sample string 6\"\n }\n ]\n}"
},
"url": {
"raw": "{{baseUrl}}/v2.1/accounts/{{accountId}}/envelopes/{{envelopeId}}/custom_fields",
"host": [
"{{baseUrl}}"
],
"path": [
"v2.1",
"accounts",
"{{accountId}}",
"envelopes",
"{{envelopeId}}",
"custom_fields"
],
"variable": [
{
"key": "accountId",
"value": "{{accountId}}",
"type": "string"
},
{
"key": "envelopeId",
"value": "{{envelopeId}}",
"type": "string"
}
]
},
"description": "Updates the envelope custom fields for draft and in-process envelopes.\n\nEach custom field used in an envelope must have a unique name."
},
"response": [
]
}