Chilkat Online Tools

unicodeC / DocuSign REST API / Delete contacts associated with an account for the DocuSign service.

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.

    // {
    //   "contacts": [
    //     {
    //       "signingGroupUsers": [
    //         {
    //           "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"
    //         }
    //       ],
    //       "contactId": "sample string 1",
    //       "name": "sample string 2",
    //       "emails": [
    //         "sample string 1"
    //       ],
    //       "organization": "sample string 3",
    //       "shared": "sample string 4",
    //       "contactUri": "sample string 5",
    //       "signingGroup": "sample string 6",
    //       "signingGroupName": "sample string 7",
    //       "contactPhoneNumbers": [
    //         {
    //           "phoneNumber": "sample string 1",
    //           "phoneType": "sample string 2"
    //         }
    //       ]
    //     }
    //   ]
    // }

    json = CkJsonObjectW_Create();
    CkJsonObjectW_UpdateString(json,L"contacts[0].signingGroupUsers[0].userName",L"sample string 1");
    CkJsonObjectW_UpdateString(json,L"contacts[0].signingGroupUsers[0].userId",L"sample string 2");
    CkJsonObjectW_UpdateString(json,L"contacts[0].signingGroupUsers[0].email",L"sample string 3");
    CkJsonObjectW_UpdateString(json,L"contacts[0].signingGroupUsers[0].userType",L"sample string 4");
    CkJsonObjectW_UpdateString(json,L"contacts[0].signingGroupUsers[0].userStatus",L"sample string 5");
    CkJsonObjectW_UpdateString(json,L"contacts[0].signingGroupUsers[0].uri",L"sample string 6");
    CkJsonObjectW_UpdateString(json,L"contacts[0].signingGroupUsers[0].loginStatus",L"sample string 7");
    CkJsonObjectW_UpdateString(json,L"contacts[0].signingGroupUsers[0].sendActivationEmail",L"sample string 8");
    CkJsonObjectW_UpdateString(json,L"contacts[0].signingGroupUsers[0].activationAccessCode",L"sample string 9");
    CkJsonObjectW_UpdateString(json,L"contacts[0].contactId",L"sample string 1");
    CkJsonObjectW_UpdateString(json,L"contacts[0].name",L"sample string 2");
    CkJsonObjectW_UpdateString(json,L"contacts[0].emails[0]",L"sample string 1");
    CkJsonObjectW_UpdateString(json,L"contacts[0].organization",L"sample string 3");
    CkJsonObjectW_UpdateString(json,L"contacts[0].shared",L"sample string 4");
    CkJsonObjectW_UpdateString(json,L"contacts[0].contactUri",L"sample string 5");
    CkJsonObjectW_UpdateString(json,L"contacts[0].signingGroup",L"sample string 6");
    CkJsonObjectW_UpdateString(json,L"contacts[0].signingGroupName",L"sample string 7");
    CkJsonObjectW_UpdateString(json,L"contacts[0].contactPhoneNumbers[0].phoneNumber",L"sample string 1");
    CkJsonObjectW_UpdateString(json,L"contacts[0].contactPhoneNumbers[0].phoneType",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"DELETE",L"https://domain.com/v2.1/accounts/{{accountId}}/contacts",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 DELETE
	-H "Accept: application/json"
	-H "Authorization: Bearer {{accessToken}}"
	-d '{
  "contacts": [
    {
      "signingGroupUsers": [
        {
          "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"
        }
      ],
      "contactId": "sample string 1",
      "name": "sample string 2",
      "emails": [
        "sample string 1"
      ],
      "organization": "sample string 3",
      "shared": "sample string 4",
      "contactUri": "sample string 5",
      "signingGroup": "sample string 6",
      "signingGroupName": "sample string 7",
      "contactPhoneNumbers": [
        {
          "phoneNumber": "sample string 1",
          "phoneType": "sample string 2"
        }
      ]
    }
  ]
}'
https://domain.com/v2.1/accounts/{{accountId}}/contacts

Postman Collection Item JSON

{
  "name": "Delete contacts associated with an account for the DocuSign service.",
  "request": {
    "method": "DELETE",
    "header": [
      {
        "key": "Accept",
        "value": "application/json"
      },
      {
        "key": "Authorization",
        "value": "Bearer {{accessToken}}"
      }
    ],
    "body": {
      "mode": "raw",
      "raw": "{\n  \"contacts\": [\n    {\n      \"signingGroupUsers\": [\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      \"contactId\": \"sample string 1\",\n      \"name\": \"sample string 2\",\n      \"emails\": [\n        \"sample string 1\"\n      ],\n      \"organization\": \"sample string 3\",\n      \"shared\": \"sample string 4\",\n      \"contactUri\": \"sample string 5\",\n      \"signingGroup\": \"sample string 6\",\n      \"signingGroupName\": \"sample string 7\",\n      \"contactPhoneNumbers\": [\n        {\n          \"phoneNumber\": \"sample string 1\",\n          \"phoneType\": \"sample string 2\"\n        }\n      ]\n    }\n  ]\n}"
    },
    "url": {
      "raw": "{{baseUrl}}/v2.1/accounts/{{accountId}}/contacts",
      "host": [
        "{{baseUrl}}"
      ],
      "path": [
        "v2.1",
        "accounts",
        "{{accountId}}",
        "contacts"
      ],
      "variable": [
        {
          "key": "accountId",
          "value": "{{accountId}}"
        }
      ]
    }
  },
  "response": [
  ]
}