Chilkat Online Tools

Swift / Sunshine Conversations API / Update App

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": "nisi",
    //   "settings": {
    //     "conversationRetentionSeconds": 84530567,
    //     "maskCreditCardNumbers": true,
    //     "useAnimalNames": true,
    //     "echoPostback": true,
    //     "ignoreAutoConversationStart": true,
    //     "multiConvoEnabled": true,
    //     "attachmentsAccess": "public",
    //     "attachmentsTokenExpirationSeconds": 64028
    //   },
    //   "metadata": {
    //     "lang": "en-ca"
    //   }
    // }

    let json = CkoJsonObject()
    json.UpdateString("displayName", value: "nisi")
    json.UpdateInt("settings.conversationRetentionSeconds", value: 84530567)
    json.UpdateBool("settings.maskCreditCardNumbers", value: true)
    json.UpdateBool("settings.useAnimalNames", value: true)
    json.UpdateBool("settings.echoPostback", value: true)
    json.UpdateBool("settings.ignoreAutoConversationStart", value: true)
    json.UpdateBool("settings.multiConvoEnabled", value: true)
    json.UpdateString("settings.attachmentsAccess", value: "public")
    json.UpdateInt("settings.attachmentsTokenExpirationSeconds", value: 64028)
    json.UpdateString("metadata.lang", value: "en-ca")

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

    let sbRequestBody = CkoStringBuilder()
    json.EmitSb(sbRequestBody)

    var resp: CkoHttpResponse? = http.PTextSb("PATCH", url: "https://domain.com/", 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)

    // {
    //   "app": {
    //     "id": "5d8cff3cd55b040010928b5b",
    //     "displayName": "utoc",
    //     "settings": {
    //       "conversationRetentionSeconds": 35855812,
    //       "maskCreditCardNumbers": true,
    //       "useAnimalNames": false,
    //       "echoPostback": true,
    //       "ignoreAutoConversationStart": true,
    //       "multiConvoEnabled": true,
    //       "attachmentsAccess": "public",
    //       "attachmentsTokenExpirationSeconds": 64028
    //     },
    //     "metadata": {
    //       "lang": "en-ca"
    //     }
    //   }
    // }

    // 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.StringOf("app.id")
    var DisplayName: String? = jResp.StringOf("app.displayName")
    var ConversationRetentionSeconds: Int = jResp.IntOf("app.settings.conversationRetentionSeconds").intValue
    var MaskCreditCardNumbers: Bool = jResp.BoolOf("app.settings.maskCreditCardNumbers")
    var UseAnimalNames: Bool = jResp.BoolOf("app.settings.useAnimalNames")
    var EchoPostback: Bool = jResp.BoolOf("app.settings.echoPostback")
    var IgnoreAutoConversationStart: Bool = jResp.BoolOf("app.settings.ignoreAutoConversationStart")
    var MultiConvoEnabled: Bool = jResp.BoolOf("app.settings.multiConvoEnabled")
    var AttachmentsAccess: String? = jResp.StringOf("app.settings.attachmentsAccess")
    var AttachmentsTokenExpirationSeconds: Int = jResp.IntOf("app.settings.attachmentsTokenExpirationSeconds").intValue
    var Lang: String? = jResp.StringOf("app.metadata.lang")

}

Curl Command

curl -X PATCH
	-u 'username:password'
	-H "Content-Type: application/json"
	-d '{
    "displayName": "nisi",
    "settings": {
        "conversationRetentionSeconds": 84530567,
        "maskCreditCardNumbers": true,
        "useAnimalNames": true,
        "echoPostback": true,
        "ignoreAutoConversationStart": true,
        "multiConvoEnabled": true,
        "attachmentsAccess": "public",
        "attachmentsTokenExpirationSeconds": 64028
    },
    "metadata": {
        "lang": "en-ca"
    }
}'
https://domain.com/

Postman Collection Item JSON

{
  "name": "Update App",
  "_postman_id": "debaf927-71d4-4229-b132-c3115827c4a1",
  "request": {
    "method": "PATCH",
    "header": [
      {
        "key": "Content-Type",
        "value": "application/json"
      }
    ],
    "body": {
      "mode": "raw",
      "raw": "{\n    \"displayName\": \"nisi\",\n    \"settings\": {\n        \"conversationRetentionSeconds\": 84530567,\n        \"maskCreditCardNumbers\": true,\n        \"useAnimalNames\": true,\n        \"echoPostback\": true,\n        \"ignoreAutoConversationStart\": true,\n        \"multiConvoEnabled\": true,\n        \"attachmentsAccess\": \"public\",\n        \"attachmentsTokenExpirationSeconds\": 64028\n    },\n    \"metadata\": {\n        \"lang\": \"en-ca\"\n    }\n}"
    },
    "url": "{{url}}/v2/apps/{{appId}}",
    "description": "Updates an app."
  },
  "response": [
    {
      "id": "3a281976-645d-4f5c-9ae9-3d6adf221d96",
      "name": "App 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\": \"nisi\",\n    \"settings\": {\n        \"conversationRetentionSeconds\": 84530567,\n        \"maskCreditCardNumbers\": true,\n        \"useAnimalNames\": true,\n        \"echoPostback\": true,\n        \"ignoreAutoConversationStart\": true,\n        \"multiConvoEnabled\": true,\n        \"attachmentsAccess\": \"public\",\n        \"attachmentsTokenExpirationSeconds\": 64028\n    },\n    \"metadata\": {\n        \"lang\": \"en-ca\"\n    }\n}"
        },
        "url": {
          "raw": "{{baseUrl}}/v2/apps/:appId",
          "host": [
            "{{baseUrl}}"
          ],
          "path": [
            "v2",
            "apps",
            ":appId"
          ],
          "variable": [
            {
              "key": "appId"
            }
          ]
        }
      },
      "status": "Not Found",
      "code": 404,
      "_postman_previewlanguage": "text",
      "header": [
        {
          "key": "Content-Type",
          "value": "text/plain"
        }
      ],
      "cookie": [
      ],
      "body": ""
    },
    {
      "id": "3f6e52ca-11d5-41da-90e7-daff0b71c219",
      "name": "App metadata is limited to 4096 bytes in size.",
      "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\": \"nisi\",\n    \"settings\": {\n        \"conversationRetentionSeconds\": 84530567,\n        \"maskCreditCardNumbers\": true,\n        \"useAnimalNames\": true,\n        \"echoPostback\": true,\n        \"ignoreAutoConversationStart\": true,\n        \"multiConvoEnabled\": true,\n        \"attachmentsAccess\": \"public\",\n        \"attachmentsTokenExpirationSeconds\": 64028\n    },\n    \"metadata\": {\n        \"lang\": \"en-ca\"\n    }\n}"
        },
        "url": {
          "raw": "{{baseUrl}}/v2/apps/:appId",
          "host": [
            "{{baseUrl}}"
          ],
          "path": [
            "v2",
            "apps",
            ":appId"
          ],
          "variable": [
            {
              "key": "appId"
            }
          ]
        }
      },
      "status": "Bad Request",
      "code": 400,
      "_postman_previewlanguage": "text",
      "header": [
        {
          "key": "Content-Type",
          "value": "text/plain"
        }
      ],
      "cookie": [
      ],
      "body": ""
    },
    {
      "id": "c86e51f9-c7d5-43d5-a82e-cd889fe21a5b",
      "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\": \"nisi\",\n    \"settings\": {\n        \"conversationRetentionSeconds\": 84530567,\n        \"maskCreditCardNumbers\": true,\n        \"useAnimalNames\": true,\n        \"echoPostback\": true,\n        \"ignoreAutoConversationStart\": true,\n        \"multiConvoEnabled\": true,\n        \"attachmentsAccess\": \"public\",\n        \"attachmentsTokenExpirationSeconds\": 64028\n    },\n    \"metadata\": {\n        \"lang\": \"en-ca\"\n    }\n}"
        },
        "url": {
          "raw": "{{baseUrl}}/v2/apps/:appId",
          "host": [
            "{{baseUrl}}"
          ],
          "path": [
            "v2",
            "apps",
            ":appId"
          ],
          "variable": [
            {
              "key": "appId"
            }
          ]
        }
      },
      "status": "OK",
      "code": 200,
      "_postman_previewlanguage": "json",
      "header": [
        {
          "key": "Content-Type",
          "value": "application/json"
        }
      ],
      "cookie": [
      ],
      "body": "{\n \"app\": {\n  \"id\": \"5d8cff3cd55b040010928b5b\",\n  \"displayName\": \"utoc\",\n  \"settings\": {\n   \"conversationRetentionSeconds\": 35855812,\n   \"maskCreditCardNumbers\": true,\n   \"useAnimalNames\": false,\n   \"echoPostback\": true,\n   \"ignoreAutoConversationStart\": true,\n   \"multiConvoEnabled\": true,\n   \"attachmentsAccess\": \"public\",\n   \"attachmentsTokenExpirationSeconds\": 64028\n  },\n  \"metadata\": {\n   \"lang\": \"en-ca\"\n  }\n }\n}"
    }
  ]
}