Chilkat Online Tools

C / DocuSign REST API / Creates an acount custom field.

Back to Collection Items

#include <C_CkHttp.h>
#include <C_CkJsonObject.h>
#include <C_CkHttpResponse.h>

void ChilkatSample(void)
    {
    HCkHttp http;
    BOOL success;
    HCkJsonObject json;
    HCkHttpResponse resp;

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

    http = CkHttp_Create();

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

    // The following JSON is sent in the request body.

    // {
    //   "fieldId": "sample string 1",
    //   "name": "sample string 2",
    //   "show": "sample string 3",
    //   "required": "sample string 4",
    //   "value": "sample string 5",
    //   "customFieldType": "sample string 6",
    //   "listItems": [
    //     "sample string 1"
    //   ]
    // }

    json = CkJsonObject_Create();
    CkJsonObject_UpdateString(json,"fieldId","sample string 1");
    CkJsonObject_UpdateString(json,"name","sample string 2");
    CkJsonObject_UpdateString(json,"show","sample string 3");
    CkJsonObject_UpdateString(json,"required","sample string 4");
    CkJsonObject_UpdateString(json,"value","sample string 5");
    CkJsonObject_UpdateString(json,"customFieldType","sample string 6");
    CkJsonObject_UpdateString(json,"listItems[0]","sample string 1");

    // Adds the "Authorization: Bearer {{accessToken}}" header.
    CkHttp_putAuthToken(http,"{{accessToken}}");
    CkHttp_SetRequestHeader(http,"Accept","application/json");

    resp = CkHttp_PostJson3(http,"https://domain.com/v2.1/accounts/{{accountId}}/custom_fields?apply_to_templates={{apply_to_templates}}","application/json",json);
    if (CkHttp_getLastMethodSuccess(http) == FALSE) {
        printf("%s\n",CkHttp_lastErrorText(http));
        CkHttp_Dispose(http);
        CkJsonObject_Dispose(json);
        return;
    }

    printf("%d\n",CkHttpResponse_getStatusCode(resp));
    printf("%s\n",CkHttpResponse_bodyStr(resp));
    CkHttpResponse_Dispose(resp);


    CkHttp_Dispose(http);
    CkJsonObject_Dispose(json);

    }

Curl Command

curl -X POST
	-H "Accept: application/json"
	-H "Authorization: Bearer {{accessToken}}"
	-d '{
  "fieldId": "sample string 1",
  "name": "sample string 2",
  "show": "sample string 3",
  "required": "sample string 4",
  "value": "sample string 5",
  "customFieldType": "sample string 6",
  "listItems": [
    "sample string 1"
  ]
}'
https://domain.com/v2.1/accounts/{{accountId}}/custom_fields?apply_to_templates={{apply_to_templates}}

Postman Collection Item JSON

{
  "name": "Creates an acount custom field.",
  "request": {
    "method": "POST",
    "header": [
      {
        "key": "Accept",
        "value": "application/json"
      },
      {
        "key": "Authorization",
        "value": "Bearer {{accessToken}}"
      }
    ],
    "body": {
      "mode": "raw",
      "raw": "{\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  \"customFieldType\": \"sample string 6\",\n  \"listItems\": [\n    \"sample string 1\"\n  ]\n}"
    },
    "url": {
      "raw": "{{baseUrl}}/v2.1/accounts/{{accountId}}/custom_fields?apply_to_templates={{apply_to_templates}}",
      "host": [
        "{{baseUrl}}"
      ],
      "path": [
        "v2.1",
        "accounts",
        "{{accountId}}",
        "custom_fields"
      ],
      "query": [
        {
          "key": "apply_to_templates",
          "value": "{{apply_to_templates}}"
        }
      ],
      "variable": [
        {
          "key": "accountId",
          "value": "{{accountId}}"
        }
      ]
    }
  },
  "response": [
  ]
}