Chilkat Online Tools

C# / DocuSign REST API / Updates a signing group.

Back to Collection Items

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

Chilkat.Http http = new Chilkat.Http();
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.

// {
//   "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"
//     }
//   ]
// }

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

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

Chilkat.StringBuilder sbRequestBody = new Chilkat.StringBuilder();
json.EmitSb(sbRequestBody);

Chilkat.HttpResponse resp = http.PTextSb("PUT","https://domain.com/v2.1/accounts/{{accountId}}/signing_groups/{{signingGroupId}}",sbRequestBody,"utf-8","application/json",false,false);
if (http.LastMethodSuccess == false) {
    Debug.WriteLine(http.LastErrorText);
    return;
}

Debug.WriteLine(Convert.ToString(resp.StatusCode));
Debug.WriteLine(resp.BodyStr);

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