Chilkat Online Tools

unicodeCpp / DocuSign REST API / Updates the group information for a group.

Back to Collection Items

#include <CkHttpW.h>
#include <CkJsonObjectW.h>
#include <CkStringBuilderW.h>
#include <CkHttpResponseW.h>

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

    CkHttpW 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.

    // {
    //   "groups": [
    //     {
    //       "groupId": "sample string 1",
    //       "groupName": "sample string 2",
    //       "permissionProfileId": "sample string 3",
    //       "groupType": "sample string 4",
    //       "users": [
    //         {
    //           "userName": "sample string 1",
    //           "userId": "sample string 2",
    //           "email": "sample string 3",
    //           "userType": "sample string 4",
    //           "userStatus": "sample string 5",
    //           "uri": "sample string 6",
    //           "loginStatus": "sample string 7",
    //           "sendActivationEmail": "sample string 8",
    //           "activationAccessCode": "sample string 9"
    //         }
    //       ]
    //     }
    //   ],
    //   "resultSetSize": "sample string 1",
    //   "totalSetSize": "sample string 2",
    //   "startPosition": "sample string 3",
    //   "endPosition": "sample string 4",
    //   "nextUri": "sample string 5",
    //   "previousUri": "sample string 6"
    // }

    CkJsonObjectW json;
    json.UpdateString(L"groups[0].groupId",L"sample string 1");
    json.UpdateString(L"groups[0].groupName",L"sample string 2");
    json.UpdateString(L"groups[0].permissionProfileId",L"sample string 3");
    json.UpdateString(L"groups[0].groupType",L"sample string 4");
    json.UpdateString(L"groups[0].users[0].userName",L"sample string 1");
    json.UpdateString(L"groups[0].users[0].userId",L"sample string 2");
    json.UpdateString(L"groups[0].users[0].email",L"sample string 3");
    json.UpdateString(L"groups[0].users[0].userType",L"sample string 4");
    json.UpdateString(L"groups[0].users[0].userStatus",L"sample string 5");
    json.UpdateString(L"groups[0].users[0].uri",L"sample string 6");
    json.UpdateString(L"groups[0].users[0].loginStatus",L"sample string 7");
    json.UpdateString(L"groups[0].users[0].sendActivationEmail",L"sample string 8");
    json.UpdateString(L"groups[0].users[0].activationAccessCode",L"sample string 9");
    json.UpdateString(L"resultSetSize",L"sample string 1");
    json.UpdateString(L"totalSetSize",L"sample string 2");
    json.UpdateString(L"startPosition",L"sample string 3");
    json.UpdateString(L"endPosition",L"sample string 4");
    json.UpdateString(L"nextUri",L"sample string 5");
    json.UpdateString(L"previousUri",L"sample string 6");

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

    CkStringBuilderW sbRequestBody;
    json.EmitSb(sbRequestBody);

    CkHttpResponseW *resp = http.PTextSb(L"PUT",L"https://domain.com/v2.1/accounts/{{accountId}}/groups",sbRequestBody,L"utf-8",L"application/json",false,false);
    if (http.get_LastMethodSuccess() == false) {
        wprintf(L"%s\n",http.lastErrorText());
        return;
    }

    wprintf(L"%d\n",resp->get_StatusCode());
    wprintf(L"%s\n",resp->bodyStr());
    delete resp;
    }

Curl Command

curl -X PUT
	-H "Accept: application/json"
	-H "Authorization: Bearer {{accessToken}}"
	-d '{
  "groups": [
    {
      "groupId": "sample string 1",
      "groupName": "sample string 2",
      "permissionProfileId": "sample string 3",
      "groupType": "sample string 4",
      "users": [
        {
          "userName": "sample string 1",
          "userId": "sample string 2",
          "email": "sample string 3",
          "userType": "sample string 4",
          "userStatus": "sample string 5",
          "uri": "sample string 6",
          "loginStatus": "sample string 7",
          "sendActivationEmail": "sample string 8",
          "activationAccessCode": "sample string 9"
        }
      ]
    }
  ],
  "resultSetSize": "sample string 1",
  "totalSetSize": "sample string 2",
  "startPosition": "sample string 3",
  "endPosition": "sample string 4",
  "nextUri": "sample string 5",
  "previousUri": "sample string 6"
}'
https://domain.com/v2.1/accounts/{{accountId}}/groups

Postman Collection Item JSON

{
  "name": "Updates the group information for a group.",
  "request": {
    "method": "PUT",
    "header": [
      {
        "key": "Accept",
        "value": "application/json"
      },
      {
        "key": "Authorization",
        "value": "Bearer {{accessToken}}"
      }
    ],
    "body": {
      "mode": "raw",
      "raw": "{\n  \"groups\": [\n    {\n      \"groupId\": \"sample string 1\",\n      \"groupName\": \"sample string 2\",\n      \"permissionProfileId\": \"sample string 3\",\n      \"groupType\": \"sample string 4\",\n      \"users\": [\n        {\n          \"userName\": \"sample string 1\",\n          \"userId\": \"sample string 2\",\n          \"email\": \"sample string 3\",\n          \"userType\": \"sample string 4\",\n          \"userStatus\": \"sample string 5\",\n          \"uri\": \"sample string 6\",\n          \"loginStatus\": \"sample string 7\",\n          \"sendActivationEmail\": \"sample string 8\",\n          \"activationAccessCode\": \"sample string 9\"\n        }\n      ]\n    }\n  ],\n  \"resultSetSize\": \"sample string 1\",\n  \"totalSetSize\": \"sample string 2\",\n  \"startPosition\": \"sample string 3\",\n  \"endPosition\": \"sample string 4\",\n  \"nextUri\": \"sample string 5\",\n  \"previousUri\": \"sample string 6\"\n}"
    },
    "url": {
      "raw": "{{baseUrl}}/v2.1/accounts/{{accountId}}/groups",
      "host": [
        "{{baseUrl}}"
      ],
      "path": [
        "v2.1",
        "accounts",
        "{{accountId}}",
        "groups"
      ],
      "variable": [
        {
          "key": "accountId",
          "value": "{{accountId}}"
        }
      ]
    },
    "description": "Updates the group name and modifies, or sets, the permission profile for the group."
  },
  "response": [
  ]
}