Chilkat Online Tools

unicodeC / DocuSign REST API / Updates a signing group.

Back to Collection Items

#include <C_CkHttpW.h>
#include <C_CkJsonObjectW.h>
#include <C_CkStringBuilderW.h>
#include <C_CkHttpResponseW.h>

void ChilkatSample(void)
    {
    HCkHttpW http;
    BOOL success;
    HCkJsonObjectW json;
    HCkStringBuilderW sbRequestBody;
    HCkHttpResponseW resp;

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

    http = CkHttpW_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.

    // {
    //   "signingGroupId": "sample string 1",
    //   "groupName": "sample string 2",
    //   "groupType": "sample string 3",
    //   "groupEmail": "sample string 4",
    //   "created": "sample string 5",
    //   "createdBy": "sample string 6",
    //   "modified": "sample string 7",
    //   "modifiedBy": "sample string 8",
    //   "users": [
    //     {
    //       "userName": "sample string 1",
    //       "email": "sample string 2"
    //     }
    //   ]
    // }

    json = CkJsonObjectW_Create();
    CkJsonObjectW_UpdateString(json,L"signingGroupId",L"sample string 1");
    CkJsonObjectW_UpdateString(json,L"groupName",L"sample string 2");
    CkJsonObjectW_UpdateString(json,L"groupType",L"sample string 3");
    CkJsonObjectW_UpdateString(json,L"groupEmail",L"sample string 4");
    CkJsonObjectW_UpdateString(json,L"created",L"sample string 5");
    CkJsonObjectW_UpdateString(json,L"createdBy",L"sample string 6");
    CkJsonObjectW_UpdateString(json,L"modified",L"sample string 7");
    CkJsonObjectW_UpdateString(json,L"modifiedBy",L"sample string 8");
    CkJsonObjectW_UpdateString(json,L"users[0].userName",L"sample string 1");
    CkJsonObjectW_UpdateString(json,L"users[0].email",L"sample string 2");

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

    sbRequestBody = CkStringBuilderW_Create();
    CkJsonObjectW_EmitSb(json,sbRequestBody);

    resp = CkHttpW_PTextSb(http,L"PUT",L"https://domain.com/v2.1/accounts/{{accountId}}/signing_groups/{{signingGroupId}}",sbRequestBody,L"utf-8",L"application/json",FALSE,FALSE);
    if (CkHttpW_getLastMethodSuccess(http) == FALSE) {
        wprintf(L"%s\n",CkHttpW_lastErrorText(http));
        CkHttpW_Dispose(http);
        CkJsonObjectW_Dispose(json);
        CkStringBuilderW_Dispose(sbRequestBody);
        return;
    }

    wprintf(L"%d\n",CkHttpResponseW_getStatusCode(resp));
    wprintf(L"%s\n",CkHttpResponseW_bodyStr(resp));
    CkHttpResponseW_Dispose(resp);


    CkHttpW_Dispose(http);
    CkJsonObjectW_Dispose(json);
    CkStringBuilderW_Dispose(sbRequestBody);

    }

Curl Command

curl -X PUT
	-H "Accept: application/json"
	-H "Authorization: Bearer {{accessToken}}"
	-d '{
  "signingGroupId": "sample string 1",
  "groupName": "sample string 2",
  "groupType": "sample string 3",
  "groupEmail": "sample string 4",
  "created": "sample string 5",
  "createdBy": "sample string 6",
  "modified": "sample string 7",
  "modifiedBy": "sample string 8",
  "users": [
    {
      "userName": "sample string 1",
      "email": "sample string 2"
    }
  ]
}'
https://domain.com/v2.1/accounts/{{accountId}}/signing_groups/{{signingGroupId}}

Postman Collection Item JSON

{
  "name": "Updates a signing group. ",
  "request": {
    "method": "PUT",
    "header": [
      {
        "key": "Accept",
        "value": "application/json"
      },
      {
        "key": "Authorization",
        "value": "Bearer {{accessToken}}"
      }
    ],
    "body": {
      "mode": "raw",
      "raw": "{\n  \"signingGroupId\": \"sample string 1\",\n  \"groupName\": \"sample string 2\",\n  \"groupType\": \"sample string 3\",\n  \"groupEmail\": \"sample string 4\",\n  \"created\": \"sample string 5\",\n  \"createdBy\": \"sample string 6\",\n  \"modified\": \"sample string 7\",\n  \"modifiedBy\": \"sample string 8\",\n  \"users\": [\n    {\n      \"userName\": \"sample string 1\",\n      \"email\": \"sample string 2\"\n    }\n  ]\n}"
    },
    "url": {
      "raw": "{{baseUrl}}/v2.1/accounts/{{accountId}}/signing_groups/{{signingGroupId}}",
      "host": [
        "{{baseUrl}}"
      ],
      "path": [
        "v2.1",
        "accounts",
        "{{accountId}}",
        "signing_groups",
        "{{signingGroupId}}"
      ],
      "variable": [
        {
          "key": "accountId",
          "value": "{{accountId}}"
        },
        {
          "key": "signingGroupId",
          "value": "{{signingGroupId}}"
        }
      ]
    },
    "description": "Updates signing group name and member information. You can also add new members to the signing group. A signing group can have a maximum of 50 members. "
  },
  "response": [
  ]
}