Back to Collection Items
import sys
import chilkat2
# This example assumes the Chilkat API to have been previously unlocked.
# See Global Unlock Sample for sample code.
http = chilkat2.Http()
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": "elit",
# "description": "Conversation between Rogers and Carl.",
# "iconUrl": "https://www.gravatar.com/image.jpg",
# "metadata": {
# "lang": "en-ca"
# }
# }
json = chilkat2.JsonObject()
json.UpdateString("displayName","elit")
json.UpdateString("description","Conversation between Rogers and Carl.")
json.UpdateString("iconUrl","https://www.gravatar.com/image.jpg")
json.UpdateString("metadata.lang","en-ca")
http.SetRequestHeader("Content-Type","application/json")
sbRequestBody = chilkat2.StringBuilder()
json.EmitSb(sbRequestBody)
# resp is a CkHttpResponse
resp = http.PTextSb("PATCH","https://domain.com/",sbRequestBody,"utf-8","application/json",False,False)
if (http.LastMethodSuccess == False):
print(http.LastErrorText)
sys.exit()
sbResponseBody = chilkat2.StringBuilder()
resp.GetBodySb(sbResponseBody)
jResp = chilkat2.JsonObject()
jResp.LoadSb(sbResponseBody)
jResp.EmitCompact = False
print("Response Body:")
print(jResp.Emit())
respStatusCode = resp.StatusCode
print("Response Status Code = " + str(respStatusCode))
if (respStatusCode >= 400):
print("Response Header:")
print(resp.Header)
print("Failed.")
sys.exit()
# 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
Id = jResp.StringOf("conversation.id")
v_Type = jResp.StringOf("conversation.type")
ActiveSwitchboardIntegrationId = jResp.StringOf("conversation.activeSwitchboardIntegration.id")
Name = jResp.StringOf("conversation.activeSwitchboardIntegration.name")
IntegrationId = jResp.StringOf("conversation.activeSwitchboardIntegration.integrationId")
IntegrationType = jResp.StringOf("conversation.activeSwitchboardIntegration.integrationType")
PendingSwitchboardIntegrationId = jResp.StringOf("conversation.pendingSwitchboardIntegration.id")
PendingSwitchboardIntegrationName = jResp.StringOf("conversation.pendingSwitchboardIntegration.name")
PendingSwitchboardIntegrationIntegrationId = jResp.StringOf("conversation.pendingSwitchboardIntegration.integrationId")
PendingSwitchboardIntegrationIntegrationType = jResp.StringOf("conversation.pendingSwitchboardIntegration.integrationType")
IsDefault = jResp.BoolOf("conversation.isDefault")
DisplayName = jResp.StringOf("conversation.displayName")
Description = jResp.StringOf("conversation.description")
IconUrl = jResp.StringOf("conversation.iconUrl")
Lang = jResp.StringOf("conversation.metadata.lang")
BusinessLastRead = jResp.StringOf("conversation.businessLastRead")
LastUpdatedAt = jResp.StringOf("conversation.lastUpdatedAt")
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": ""
}
]
}
