Chilkat Online Tools

Foxpro / DocuSign eSignature REST API / Adds/updates a user signature.

Back to Collection Items

LOCAL loHttp
LOCAL lnSuccess
LOCAL loJson
LOCAL loSbRequestBody
LOCAL loResp

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

* For versions of Chilkat < 10.0.0, use CreateObject('Chilkat_9_5_0.Http')
loHttp = CreateObject('Chilkat.Http')

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

* The following JSON is sent in the request body.

* {
*   "userSignatures": [
*     {
*       "signatureId": "sample string 1",
*       "stampType": "sample string 2",
*       "phoneticName": "sample string 3",
*       "imageType": "sample string 4",
*       "externalID": "sample string 5",
*       "stampSizeMM": "sample string 6",
*       "stampFormat": "sample string 7",
*       "dateStampProperties": {
*         "dateAreaX": "sample string 1",
*         "dateAreaY": "sample string 2",
*         "dateAreaWidth": "sample string 3",
*         "dateAreaHeight": "sample string 4"
*       },
*       "stampImageUri": "sample string 8",
*       "signatureFont": "sample string 9",
*       "signatureType": "sample string 10",
*       "signatureName": "sample string 11",
*       "signatureImageUri": "sample string 12",
*       "signatureInitials": "sample string 13",
*       "initialsImageUri": "sample string 14",
*       "createdDateTime": "sample string 15",
*       "adoptedDateTime": "sample string 16",
*       "signature150ImageId": "sample string 17",
*       "initials150ImageId": "sample string 18"
*     }
*   ]
* }

* For versions of Chilkat < 10.0.0, use CreateObject('Chilkat_9_5_0.JsonObject')
loJson = CreateObject('Chilkat.JsonObject')
loJson.UpdateString("userSignatures[0].signatureId","sample string 1")
loJson.UpdateString("userSignatures[0].stampType","sample string 2")
loJson.UpdateString("userSignatures[0].phoneticName","sample string 3")
loJson.UpdateString("userSignatures[0].imageType","sample string 4")
loJson.UpdateString("userSignatures[0].externalID","sample string 5")
loJson.UpdateString("userSignatures[0].stampSizeMM","sample string 6")
loJson.UpdateString("userSignatures[0].stampFormat","sample string 7")
loJson.UpdateString("userSignatures[0].dateStampProperties.dateAreaX","sample string 1")
loJson.UpdateString("userSignatures[0].dateStampProperties.dateAreaY","sample string 2")
loJson.UpdateString("userSignatures[0].dateStampProperties.dateAreaWidth","sample string 3")
loJson.UpdateString("userSignatures[0].dateStampProperties.dateAreaHeight","sample string 4")
loJson.UpdateString("userSignatures[0].stampImageUri","sample string 8")
loJson.UpdateString("userSignatures[0].signatureFont","sample string 9")
loJson.UpdateString("userSignatures[0].signatureType","sample string 10")
loJson.UpdateString("userSignatures[0].signatureName","sample string 11")
loJson.UpdateString("userSignatures[0].signatureImageUri","sample string 12")
loJson.UpdateString("userSignatures[0].signatureInitials","sample string 13")
loJson.UpdateString("userSignatures[0].initialsImageUri","sample string 14")
loJson.UpdateString("userSignatures[0].createdDateTime","sample string 15")
loJson.UpdateString("userSignatures[0].adoptedDateTime","sample string 16")
loJson.UpdateString("userSignatures[0].signature150ImageId","sample string 17")
loJson.UpdateString("userSignatures[0].initials150ImageId","sample string 18")

* Adds the "Authorization: Bearer {{accessToken}}" header.
loHttp.AuthToken = "{{accessToken}}"
loHttp.SetRequestHeader("Accept","application/json")

* For versions of Chilkat < 10.0.0, use CreateObject('Chilkat_9_5_0.StringBuilder')
loSbRequestBody = CreateObject('Chilkat.StringBuilder')
loJson.EmitSb(loSbRequestBody)

loResp = loHttp.PTextSb("PUT","https://domain.com/v2.1/accounts/{{accountId}}/users/{{userId}}/signatures",loSbRequestBody,"utf-8","application/json",0,0)
IF (loHttp.LastMethodSuccess = 0) THEN
    ? loHttp.LastErrorText
    RELEASE loHttp
    RELEASE loJson
    RELEASE loSbRequestBody
    CANCEL
ENDIF

? STR(loResp.StatusCode)
? loResp.BodyStr
RELEASE loResp

RELEASE loHttp
RELEASE loJson
RELEASE loSbRequestBody

Curl Command

curl -X PUT
	-H "Accept: application/json"
	-H "Authorization: Bearer {{accessToken}}"
	-d '{
  "userSignatures": [
    {
      "signatureId": "sample string 1",
      "stampType": "sample string 2",
      "phoneticName": "sample string 3",
      "imageType": "sample string 4",
      "externalID": "sample string 5",
      "stampSizeMM": "sample string 6",
      "stampFormat": "sample string 7",
      "dateStampProperties": {
        "dateAreaX": "sample string 1",
        "dateAreaY": "sample string 2",
        "dateAreaWidth": "sample string 3",
        "dateAreaHeight": "sample string 4"
      },
      "stampImageUri": "sample string 8",
      "signatureFont": "sample string 9",
      "signatureType": "sample string 10",
      "signatureName": "sample string 11",
      "signatureImageUri": "sample string 12",
      "signatureInitials": "sample string 13",
      "initialsImageUri": "sample string 14",
      "createdDateTime": "sample string 15",
      "adoptedDateTime": "sample string 16",
      "signature150ImageId": "sample string 17",
      "initials150ImageId": "sample string 18"
    }
  ]
}'
https://domain.com/v2.1/accounts/{{accountId}}/users/{{userId}}/signatures

Postman Collection Item JSON

{
  "name": "Adds/updates a user signature.",
  "request": {
    "method": "PUT",
    "header": [
      {
        "key": "Accept",
        "value": "application/json"
      },
      {
        "key": "Authorization",
        "value": "Bearer {{accessToken}}"
      }
    ],
    "body": {
      "mode": "raw",
      "raw": "{\n  \"userSignatures\": [\n    {\n      \"signatureId\": \"sample string 1\",\n      \"stampType\": \"sample string 2\",\n      \"phoneticName\": \"sample string 3\",\n      \"imageType\": \"sample string 4\",\n      \"externalID\": \"sample string 5\",\n      \"stampSizeMM\": \"sample string 6\",\n      \"stampFormat\": \"sample string 7\",\n      \"dateStampProperties\": {\n        \"dateAreaX\": \"sample string 1\",\n        \"dateAreaY\": \"sample string 2\",\n        \"dateAreaWidth\": \"sample string 3\",\n        \"dateAreaHeight\": \"sample string 4\"\n      },\n      \"stampImageUri\": \"sample string 8\",\n      \"signatureFont\": \"sample string 9\",\n      \"signatureType\": \"sample string 10\",\n      \"signatureName\": \"sample string 11\",\n      \"signatureImageUri\": \"sample string 12\",\n      \"signatureInitials\": \"sample string 13\",\n      \"initialsImageUri\": \"sample string 14\",\n      \"createdDateTime\": \"sample string 15\",\n      \"adoptedDateTime\": \"sample string 16\",\n      \"signature150ImageId\": \"sample string 17\",\n      \"initials150ImageId\": \"sample string 18\"\n    }\n  ]\n}"
    },
    "url": {
      "raw": "{{baseUrl}}/v2.1/accounts/{{accountId}}/users/{{userId}}/signatures",
      "host": [
        "{{baseUrl}}"
      ],
      "path": [
        "v2.1",
        "accounts",
        "{{accountId}}",
        "users",
        "{{userId}}",
        "signatures"
      ],
      "variable": [
        {
          "key": "accountId",
          "value": "{{accountId}}",
          "type": "string"
        },
        {
          "key": "userId",
          "value": "{{userId}}",
          "type": "string"
        }
      ]
    }
  },
  "response": [
  ]
}