Chilkat Online Tools

delphiAx / Sunshine Conversations API / Update Integration

Back to Collection Items

var
http: TChilkatHttp;
success: Integer;
json: TChilkatJsonObject;
sbRequestBody: TChilkatStringBuilder;
resp: IChilkatHttpResponse;
sbResponseBody: TChilkatStringBuilder;
jResp: TChilkatJsonObject;
respStatusCode: Integer;
Id: WideString;
v_Type: WideString;
Status: WideString;
DisplayName: WideString;
ServerId: WideString;
CanUserCreateMoreConversations: Integer;

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

http := TChilkatHttp.Create(Self);

http.BasicAuth := 1;
http.Login := 'username';
http.Password := '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": "My awesome integration",
//   "serverKey": "<server-key>",
//   "senderId": "<sender-id>",
//   "canUserCreateConversation": false
// }

json := TChilkatJsonObject.Create(Self);
json.UpdateString('displayName','My awesome integration');
json.UpdateString('serverKey','<server-key>');
json.UpdateString('senderId','<sender-id>');
json.UpdateBool('canUserCreateConversation',0);

http.SetRequestHeader('Content-Type','application/json');

sbRequestBody := TChilkatStringBuilder.Create(Self);
json.EmitSb(sbRequestBody.ControlInterface);

resp := http.PTextSb('PATCH','https://domain.com/v2/apps/{{appId}}/integrations/:integrationId',sbRequestBody.ControlInterface,'utf-8','application/json',0,0);
if (http.LastMethodSuccess = 0) then
  begin
    Memo1.Lines.Add(http.LastErrorText);
    Exit;
  end;

sbResponseBody := TChilkatStringBuilder.Create(Self);
resp.GetBodySb(sbResponseBody.ControlInterface);

jResp := TChilkatJsonObject.Create(Self);
jResp.LoadSb(sbResponseBody.ControlInterface);
jResp.EmitCompact := 0;

Memo1.Lines.Add('Response Body:');
Memo1.Lines.Add(jResp.Emit());

respStatusCode := resp.StatusCode;
Memo1.Lines.Add('Response Status Code = ' + IntToStr(respStatusCode));
if (respStatusCode >= 400) then
  begin
    Memo1.Lines.Add('Response Header:');
    Memo1.Lines.Add(resp.Header);
    Memo1.Lines.Add('Failed.');

    Exit;
  end;

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

// {
//   "integration": {
//     "id": "5e4af71a81966cfff3ef6550",
//     "type": "android",
//     "status": "active",
//     "displayName": "Android",
//     "serverId": "<sender-id>",
//     "canUserCreateMoreConversations": true
//   }
// }

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

Id := jResp.StringOf('integration.id');
v_Type := jResp.StringOf('integration.type');
Status := jResp.StringOf('integration.status');
DisplayName := jResp.StringOf('integration.displayName');
ServerId := jResp.StringOf('integration.serverId');
CanUserCreateMoreConversations := jResp.BoolOf('integration.canUserCreateMoreConversations');

Curl Command

curl -X PATCH
	-u 'username:password'
	-H "Content-Type: application/json"
	-d '{
    "displayName": "My awesome integration",
    "serverKey": "<server-key>",
    "senderId": "<sender-id>",
    "canUserCreateConversation": false
}'
https://domain.com/v2/apps/{{appId}}/integrations/:integrationId

Postman Collection Item JSON

{
  "name": "Update Integration",
  "_postman_id": "08d2d65c-5d81-4bc8-b5a9-feb8c27b4529",
  "request": {
    "method": "PATCH",
    "header": [
      {
        "key": "Content-Type",
        "value": "application/json"
      }
    ],
    "body": {
      "mode": "raw",
      "raw": "{\n    \"displayName\": \"My awesome integration\",\n    \"serverKey\": \"<server-key>\",\n    \"senderId\": \"<sender-id>\",\n    \"canUserCreateConversation\": false\n}"
    },
    "url": {
      "raw": "{{url}}/v2/apps/{{appId}}/integrations/:integrationId",
      "host": [
        "{{url}}"
      ],
      "path": [
        "v2",
        "apps",
        "{{appId}}",
        "integrations",
        ":integrationId"
      ],
      "variable": [
        {
          "key": "integrationId"
        }
      ]
    },
    "description": "Allows you to update certain fields of existing integrations. If updating a specific property is not supported, you must delete the integration and re-create it with the new data."
  },
  "response": [
    {
      "id": "70fa76fe-4bb4-4a55-a725-441c3c6184e2",
      "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\": \"My awesome integration\",\n    \"serverKey\": \"<server-key>\",\n    \"senderId\": \"<sender-id>\",\n    \"canUserCreateConversation\": false\n}"
        },
        "url": {
          "raw": "{{baseUrl}}/v2/apps/:appId/integrations/:integrationId",
          "host": [
            "{{baseUrl}}"
          ],
          "path": [
            "v2",
            "apps",
            ":appId",
            "integrations",
            ":integrationId"
          ],
          "variable": [
            {
              "key": "appId"
            },
            {
              "key": "integrationId"
            }
          ]
        }
      },
      "status": "OK",
      "code": 200,
      "_postman_previewlanguage": "json",
      "header": [
        {
          "key": "Content-Type",
          "value": "application/json"
        }
      ],
      "cookie": [
      ],
      "body": "{\n \"integration\": {\n  \"id\": \"5e4af71a81966cfff3ef6550\",\n  \"type\": \"android\",\n  \"status\": \"active\",\n  \"displayName\": \"Android\",\n  \"serverId\": \"<sender-id>\",\n  \"canUserCreateMoreConversations\": true\n }\n}"
    },
    {
      "id": "adb4998f-c795-4e73-8c58-ea7c2b90d249",
      "name": "Integration 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\": \"My awesome integration\",\n    \"serverKey\": \"<server-key>\",\n    \"senderId\": \"<sender-id>\",\n    \"canUserCreateConversation\": false\n}"
        },
        "url": {
          "raw": "{{baseUrl}}/v2/apps/:appId/integrations/:integrationId",
          "host": [
            "{{baseUrl}}"
          ],
          "path": [
            "v2",
            "apps",
            ":appId",
            "integrations",
            ":integrationId"
          ],
          "variable": [
            {
              "key": "appId"
            },
            {
              "key": "integrationId"
            }
          ]
        }
      },
      "status": "Not Found",
      "code": 404,
      "_postman_previewlanguage": "text",
      "header": [
        {
          "key": "Content-Type",
          "value": "text/plain"
        }
      ],
      "cookie": [
      ],
      "body": ""
    }
  ]
}