Chilkat Online Tools

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

Back to Collection Items

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

$oHttp = ObjCreate("Chilkat.Http")
Local $bSuccess

; 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"
;   ]
; }

$oJson = ObjCreate("Chilkat.JsonObject")
$oJson.UpdateString("fieldId","sample string 1")
$oJson.UpdateString("name","sample string 2")
$oJson.UpdateString("show","sample string 3")
$oJson.UpdateString("required","sample string 4")
$oJson.UpdateString("value","sample string 5")
$oJson.UpdateString("customFieldType","sample string 6")
$oJson.UpdateString("listItems[0]","sample string 1")

; Adds the "Authorization: Bearer {{accessToken}}" header.
$oHttp.AuthToken = "{{accessToken}}"
$oHttp.SetRequestHeader "Accept","application/json"

Local $oResp = $oHttp.PostJson3("https://domain.com/v2.1/accounts/{{accountId}}/custom_fields?apply_to_templates={{apply_to_templates}}","application/json",$oJson)
If ($oHttp.LastMethodSuccess = False) Then
    ConsoleWrite($oHttp.LastErrorText & @CRLF)
    Exit
EndIf

ConsoleWrite($oResp.StatusCode & @CRLF)
ConsoleWrite($oResp.BodyStr & @CRLF)

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": [
  ]
}