Chilkat Online Tools

Swift3 / Sunshine Conversations API / Update Integration

Back to Collection Items

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

    let http = CkoHttp()!
    var success: Bool

    http.basicAuth = true
    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
    // }

    let json = CkoJsonObject()!
    json.update("displayName", value: "My awesome integration")
    json.update("serverKey", value: "<server-key>")
    json.update("senderId", value: "<sender-id>")
    json.updateBool("canUserCreateConversation", value: false)

    http.setRequestHeader("Content-Type", value: "application/json")

    let sbRequestBody = CkoStringBuilder()!
    json.emitSb(sbRequestBody)

    var resp: CkoHttpResponse? = http.pTextSb("PATCH", url: "https://domain.com/v2/apps/{{appId}}/integrations/:integrationId", textData: sbRequestBody, charset: "utf-8", contentType: "application/json", md5: false, gzip: false)
    if http.lastMethodSuccess == false {
        print("\(http.lastErrorText!)")
        return
    }

    let sbResponseBody = CkoStringBuilder()!
    resp!.getBodySb(sbResponseBody)

    let jResp = CkoJsonObject()!
    jResp.loadSb(sbResponseBody)
    jResp.emitCompact = false

    print("Response Body:")
    print("\(jResp.emit()!)")

    var respStatusCode: Int = resp!.statusCode.intValue
    print("Response Status Code = \(respStatusCode)")
    if respStatusCode >= 400 {
        print("Response Header:")
        print("\(resp!.header!)")
        print("Failed.")
        resp = nil
        return
    }

    resp = nil

    // 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

    var Id: String? = jResp.string(of: "integration.id")
    var v_Type: String? = jResp.string(of: "integration.type")
    var Status: String? = jResp.string(of: "integration.status")
    var DisplayName: String? = jResp.string(of: "integration.displayName")
    var ServerId: String? = jResp.string(of: "integration.serverId")
    var CanUserCreateMoreConversations: Bool = jResp.bool(of: "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": ""
    }
  ]
}