Chilkat Online Tools

unicodeC / Sunshine Conversations API / Update Conversation

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;
    HCkStringBuilderW sbResponseBody;
    HCkJsonObjectW jResp;
    int respStatusCode;
    const wchar_t *Id;
    const wchar_t *v_Type;
    const wchar_t *ActiveSwitchboardIntegrationId;
    const wchar_t *Name;
    const wchar_t *IntegrationId;
    const wchar_t *IntegrationType;
    const wchar_t *PendingSwitchboardIntegrationId;
    const wchar_t *PendingSwitchboardIntegrationName;
    const wchar_t *PendingSwitchboardIntegrationIntegrationId;
    const wchar_t *PendingSwitchboardIntegrationIntegrationType;
    BOOL IsDefault;
    const wchar_t *DisplayName;
    const wchar_t *Description;
    const wchar_t *IconUrl;
    const wchar_t *Lang;
    const wchar_t *BusinessLastRead;
    const wchar_t *LastUpdatedAt;

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

    http = CkHttpW_Create();

    CkHttpW_putBasicAuth(http,TRUE);
    CkHttpW_putLogin(http,L"username");
    CkHttpW_putPassword(http,L"password");

    // Use this online tool to generate code from sample JSON: Generate Code to Create JSON

    // The following JSON is sent in the request body.

    // {
    //   "displayName": "elit",
    //   "description": "Conversation between Rogers and Carl.",
    //   "iconUrl": "https://www.gravatar.com/image.jpg",
    //   "metadata": {
    //     "lang": "en-ca"
    //   }
    // }

    json = CkJsonObjectW_Create();
    CkJsonObjectW_UpdateString(json,L"displayName",L"elit");
    CkJsonObjectW_UpdateString(json,L"description",L"Conversation between Rogers and Carl.");
    CkJsonObjectW_UpdateString(json,L"iconUrl",L"https://www.gravatar.com/image.jpg");
    CkJsonObjectW_UpdateString(json,L"metadata.lang",L"en-ca");

    CkHttpW_SetRequestHeader(http,L"Content-Type",L"application/json");

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

    resp = CkHttpW_PTextSb(http,L"PATCH",L"https://domain.com/",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;
    }

    sbResponseBody = CkStringBuilderW_Create();
    CkHttpResponseW_GetBodySb(resp,sbResponseBody);

    jResp = CkJsonObjectW_Create();
    CkJsonObjectW_LoadSb(jResp,sbResponseBody);
    CkJsonObjectW_putEmitCompact(jResp,FALSE);

    wprintf(L"Response Body:\n");
    wprintf(L"%s\n",CkJsonObjectW_emit(jResp));

    respStatusCode = CkHttpResponseW_getStatusCode(resp);
    wprintf(L"Response Status Code = %d\n",respStatusCode);
    if (respStatusCode >= 400) {
        wprintf(L"Response Header:\n");
        wprintf(L"%s\n",CkHttpResponseW_header(resp));
        wprintf(L"Failed.\n");
        CkHttpResponseW_Dispose(resp);
        CkHttpW_Dispose(http);
        CkJsonObjectW_Dispose(json);
        CkStringBuilderW_Dispose(sbRequestBody);
        CkStringBuilderW_Dispose(sbResponseBody);
        CkJsonObjectW_Dispose(jResp);
        return;
    }

    CkHttpResponseW_Dispose(resp);

    // Sample JSON response:
    // (Sample code for parsing the JSON response is shown below)

    // {
    //   "conversation": {
    //     "id": "c93bb9c14dde8ffb94564eae",
    //     "type": "personal",
    //     "activeSwitchboardIntegration": {
    //       "id": "5ef21b86e933b7355c11c604",
    //       "name": "bot",
    //       "integrationId": "5ef21b86e933b7355c11c605",
    //       "integrationType": "zd:agentWorkspace"
    //     },
    //     "pendingSwitchboardIntegration": {
    //       "id": "5ef21b86e933b7355c11c604",
    //       "name": "bot",
    //       "integrationId": "5ef21b86e933b7355c11c605",
    //       "integrationType": "zd:agentWorkspace"
    //     },
    //     "isDefault": false,
    //     "displayName": "pari",
    //     "description": "Conversation between Rogers and Carl.",
    //     "iconUrl": "https://www.gravatar.com/image.jpg",
    //     "metadata": {
    //       "lang": "en-ca"
    //     },
    //     "businessLastRead": "2020-06-23T14:33:47.492Z",
    //     "lastUpdatedAt": "2020-06-26T14:33:47.120Z"
    //   }
    // }

    // Sample code for parsing the JSON response...
    // Use this online tool to generate parsing code from sample JSON: Generate JSON Parsing Code

    // Chilkat functions returning "const char *" return a pointer to temporary internal memory owned and managed by Chilkat.

    Id = CkJsonObjectW_stringOf(jResp,L"conversation.id");
    v_Type = CkJsonObjectW_stringOf(jResp,L"conversation.type");
    ActiveSwitchboardIntegrationId = CkJsonObjectW_stringOf(jResp,L"conversation.activeSwitchboardIntegration.id");
    Name = CkJsonObjectW_stringOf(jResp,L"conversation.activeSwitchboardIntegration.name");
    IntegrationId = CkJsonObjectW_stringOf(jResp,L"conversation.activeSwitchboardIntegration.integrationId");
    IntegrationType = CkJsonObjectW_stringOf(jResp,L"conversation.activeSwitchboardIntegration.integrationType");
    PendingSwitchboardIntegrationId = CkJsonObjectW_stringOf(jResp,L"conversation.pendingSwitchboardIntegration.id");
    PendingSwitchboardIntegrationName = CkJsonObjectW_stringOf(jResp,L"conversation.pendingSwitchboardIntegration.name");
    PendingSwitchboardIntegrationIntegrationId = CkJsonObjectW_stringOf(jResp,L"conversation.pendingSwitchboardIntegration.integrationId");
    PendingSwitchboardIntegrationIntegrationType = CkJsonObjectW_stringOf(jResp,L"conversation.pendingSwitchboardIntegration.integrationType");
    IsDefault = CkJsonObjectW_BoolOf(jResp,L"conversation.isDefault");
    DisplayName = CkJsonObjectW_stringOf(jResp,L"conversation.displayName");
    Description = CkJsonObjectW_stringOf(jResp,L"conversation.description");
    IconUrl = CkJsonObjectW_stringOf(jResp,L"conversation.iconUrl");
    Lang = CkJsonObjectW_stringOf(jResp,L"conversation.metadata.lang");
    BusinessLastRead = CkJsonObjectW_stringOf(jResp,L"conversation.businessLastRead");
    LastUpdatedAt = CkJsonObjectW_stringOf(jResp,L"conversation.lastUpdatedAt");


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

    }

Curl Command

curl -X PATCH
	-u 'username:password'
	-H "Content-Type: application/json"
	-d '{
    "displayName": "elit",
    "description": "Conversation between Rogers and Carl.",
    "iconUrl": "https://www.gravatar.com/image.jpg",
    "metadata": {
        "lang": "en-ca"
    }
}'
https://domain.com/

Postman Collection Item JSON

{
  "name": "Update Conversation",
  "_postman_id": "96737822-d414-42cf-a54c-b19311a3b68d",
  "request": {
    "method": "PATCH",
    "header": [
      {
        "key": "Content-Type",
        "value": "application/json"
      }
    ],
    "body": {
      "mode": "raw",
      "raw": "{\n    \"displayName\": \"elit\",\n    \"description\": \"Conversation between Rogers and Carl.\",\n    \"iconUrl\": \"https://www.gravatar.com/image.jpg\",\n    \"metadata\": {\n        \"lang\": \"en-ca\"\n    }\n}"
    },
    "url": "{{url}}/v2/apps/{{appId}}/conversations/{{conversationId}}",
    "description": "Updates a conversation record."
  },
  "response": [
    {
      "id": "f49e0f88-7c9f-4500-951a-95341d87cbb5",
      "name": "Ok",
      "originalRequest": {
        "method": "PATCH",
        "header": [
          {
            "description": {
              "content": "Added as a part of security scheme: bearer",
              "type": "text/plain"
            },
            "key": "Authorization",
            "value": "Bearer <token>"
          }
        ],
        "body": {
          "mode": "raw",
          "raw": "{\n    \"displayName\": \"elit\",\n    \"description\": \"Conversation between Rogers and Carl.\",\n    \"iconUrl\": \"https://www.gravatar.com/image.jpg\",\n    \"metadata\": {\n        \"lang\": \"en-ca\"\n    }\n}"
        },
        "url": {
          "raw": "{{baseUrl}}/v2/apps/:appId/conversations/:conversationId",
          "host": [
            "{{baseUrl}}"
          ],
          "path": [
            "v2",
            "apps",
            ":appId",
            "conversations",
            ":conversationId"
          ],
          "variable": [
            {
              "key": "appId"
            },
            {
              "key": "conversationId"
            }
          ]
        }
      },
      "status": "OK",
      "code": 200,
      "_postman_previewlanguage": "json",
      "header": [
        {
          "key": "Content-Type",
          "value": "application/json"
        }
      ],
      "cookie": [
      ],
      "body": "{\n \"conversation\": {\n  \"id\": \"c93bb9c14dde8ffb94564eae\",\n  \"type\": \"personal\",\n  \"activeSwitchboardIntegration\": {\n   \"id\": \"5ef21b86e933b7355c11c604\",\n   \"name\": \"bot\",\n   \"integrationId\": \"5ef21b86e933b7355c11c605\",\n   \"integrationType\": \"zd:agentWorkspace\"\n  },\n  \"pendingSwitchboardIntegration\": {\n   \"id\": \"5ef21b86e933b7355c11c604\",\n   \"name\": \"bot\",\n   \"integrationId\": \"5ef21b86e933b7355c11c605\",\n   \"integrationType\": \"zd:agentWorkspace\"\n  },\n  \"isDefault\": false,\n  \"displayName\": \"pari\",\n  \"description\": \"Conversation between Rogers and Carl.\",\n  \"iconUrl\": \"https://www.gravatar.com/image.jpg\",\n  \"metadata\": {\n   \"lang\": \"en-ca\"\n  },\n  \"businessLastRead\": \"2020-06-23T14:33:47.492Z\",\n  \"lastUpdatedAt\": \"2020-06-26T14:33:47.120Z\"\n }\n}"
    },
    {
      "id": "ffbec026-9563-44d8-afb5-d5aaa54230b9",
      "name": "Conversation not found",
      "originalRequest": {
        "method": "PATCH",
        "header": [
          {
            "description": {
              "content": "Added as a part of security scheme: bearer",
              "type": "text/plain"
            },
            "key": "Authorization",
            "value": "Bearer <token>"
          }
        ],
        "body": {
          "mode": "raw",
          "raw": "{\n    \"displayName\": \"elit\",\n    \"description\": \"Conversation between Rogers and Carl.\",\n    \"iconUrl\": \"https://www.gravatar.com/image.jpg\",\n    \"metadata\": {\n        \"lang\": \"en-ca\"\n    }\n}"
        },
        "url": {
          "raw": "{{baseUrl}}/v2/apps/:appId/conversations/:conversationId",
          "host": [
            "{{baseUrl}}"
          ],
          "path": [
            "v2",
            "apps",
            ":appId",
            "conversations",
            ":conversationId"
          ],
          "variable": [
            {
              "key": "appId"
            },
            {
              "key": "conversationId"
            }
          ]
        }
      },
      "status": "Not Found",
      "code": 404,
      "_postman_previewlanguage": "text",
      "header": [
        {
          "key": "Content-Type",
          "value": "text/plain"
        }
      ],
      "cookie": [
      ],
      "body": ""
    }
  ]
}