Chilkat Online Tools

C / DocuSign eSignature REST API / Deletes an existing user group.

Back to Collection Items

#include <C_CkHttp.h>
#include <C_CkJsonObject.h>
#include <C_CkStringBuilder.h>
#include <C_CkHttpResponse.h>

void ChilkatSample(void)
    {
    HCkHttp http;
    BOOL success;
    HCkJsonObject json;
    HCkStringBuilder sbRequestBody;
    HCkHttpResponse resp;

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

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

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

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

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

    sbRequestBody = CkStringBuilder_Create();
    CkJsonObject_EmitSb(json,sbRequestBody);

    resp = CkHttp_PTextSb(http,"DELETE","https://domain.com/v2.1/accounts/{{accountId}}/groups",sbRequestBody,"utf-8","application/json",FALSE,FALSE);
    if (CkHttp_getLastMethodSuccess(http) == FALSE) {
        printf("%s\n",CkHttp_lastErrorText(http));
        CkHttp_Dispose(http);
        CkJsonObject_Dispose(json);
        CkStringBuilder_Dispose(sbRequestBody);
        return;
    }

    printf("%d\n",CkHttpResponse_getStatusCode(resp));
    printf("%s\n",CkHttpResponse_bodyStr(resp));
    CkHttpResponse_Dispose(resp);


    CkHttp_Dispose(http);
    CkJsonObject_Dispose(json);
    CkStringBuilder_Dispose(sbRequestBody);

    }

Curl Command

curl -X DELETE
	-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": "Deletes an existing user group.",
  "request": {
    "method": "DELETE",
    "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}}",
          "type": "string"
        }
      ]
    },
    "description": "Deletes an existing user group."
  },
  "response": [
  ]
}