Chilkat Online Tools

Objective-C / DocuSign REST API / Updates envelope custom fields for an envelope.

Back to Collection Items

#import <CkoHttp.h>
#import <CkoJsonObject.h>
#import <CkoHttpResponse.h>

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

CkoHttp *http = [[CkoHttp alloc] init];
BOOL 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"
//     }
//   ]
// }

CkoJsonObject *json = [[CkoJsonObject alloc] init];
[json UpdateString: @"textCustomFields[0].fieldId" value: @"sample string 1"];
[json UpdateString: @"textCustomFields[0].name" value: @"sample string 2"];
[json UpdateString: @"textCustomFields[0].show" value: @"sample string 3"];
[json UpdateString: @"textCustomFields[0].required" value: @"sample string 4"];
[json UpdateString: @"textCustomFields[0].value" value: @"sample string 5"];
[json UpdateString: @"textCustomFields[0].configurationType" value: @"sample string 6"];
[json UpdateString: @"listCustomFields[0].listItems[0]" value: @"sample string 1"];
[json UpdateString: @"listCustomFields[0].fieldId" value: @"sample string 1"];
[json UpdateString: @"listCustomFields[0].name" value: @"sample string 2"];
[json UpdateString: @"listCustomFields[0].show" value: @"sample string 3"];
[json UpdateString: @"listCustomFields[0].required" value: @"sample string 4"];
[json UpdateString: @"listCustomFields[0].value" value: @"sample string 5"];
[json UpdateString: @"listCustomFields[0].configurationType" value: @"sample string 6"];

// Adds the "Authorization: Bearer {{accessToken}}" header.
http.AuthToken = @"{{accessToken}}";
[http SetRequestHeader: @"Accept" value: @"application/json"];

CkoHttpResponse *resp = [http PostJson3: @"https://domain.com/v2.1/accounts/{{accountId}}/envelopes/{{envelopeId}}/custom_fields" contentType: @"application/json" json: json];
if (http.LastMethodSuccess == NO) {
    NSLog(@"%@",http.LastErrorText);
    return;
}

NSLog(@"%d",[resp.StatusCode intValue]);
NSLog(@"%@",resp.BodyStr);

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}}"
        },
        {
          "key": "envelopeId",
          "value": "{{envelopeId}}"
        }
      ]
    },
    "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": [
  ]
}