Chilkat Online Tools

Python / Support API / Update Item

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 = "login"
http.Password = "password"

http.SetRequestHeader("Accept","application/json")

# resp is a CkHttpResponse
resp = http.QuickRequest("PUT","https://example.zendesk.com/api/v2/dynamic_content/items/:dynamic_content_item_id")
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)

# {
#   "item": {
#     "name": "<string>",
#     "default_locale_id": "<integer>",
#     "variants": [
#       {
#         "content": "<string>",
#         "locale_id": "<integer>",
#         "active": "<boolean>",
#         "created_at": "<dateTime>",
#         "default": "<boolean>",
#         "id": "<integer>",
#         "outdated": "<boolean>",
#         "updated_at": "<dateTime>",
#         "url": "<string>"
#       },
#       {
#         "content": "<string>",
#         "locale_id": "<integer>",
#         "active": "<boolean>",
#         "created_at": "<dateTime>",
#         "default": "<boolean>",
#         "id": "<integer>",
#         "outdated": "<boolean>",
#         "updated_at": "<dateTime>",
#         "url": "<string>"
#       }
#     ],
#     "created_at": "<dateTime>",
#     "id": "<integer>",
#     "outdated": "<boolean>",
#     "placeholder": "<string>",
#     "updated_at": "<dateTime>",
#     "url": "<string>"
#   }
# }

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

Name = jResp.StringOf("item.name")
Default_locale_id = jResp.StringOf("item.default_locale_id")
Created_at = jResp.StringOf("item.created_at")
Id = jResp.StringOf("item.id")
Outdated = jResp.StringOf("item.outdated")
Placeholder = jResp.StringOf("item.placeholder")
Updated_at = jResp.StringOf("item.updated_at")
v_Url = jResp.StringOf("item.url")
i = 0
count_i = jResp.SizeOfArray("item.variants")
while i < count_i :
    jResp.I = i
    content = jResp.StringOf("item.variants[i].content")
    locale_id = jResp.StringOf("item.variants[i].locale_id")
    active = jResp.StringOf("item.variants[i].active")
    created_at = jResp.StringOf("item.variants[i].created_at")
    default = jResp.StringOf("item.variants[i].default")
    id = jResp.StringOf("item.variants[i].id")
    outdated = jResp.StringOf("item.variants[i].outdated")
    updated_at = jResp.StringOf("item.variants[i].updated_at")
    url = jResp.StringOf("item.variants[i].url")
    i = i + 1

Curl Command

curl  -u login:password -X PUT
	-H "Accept: application/json"
https://example.zendesk.com/api/v2/dynamic_content/items/:dynamic_content_item_id

Postman Collection Item JSON

{
  "name": "Update Item",
  "request": {
    "method": "PUT",
    "header": [
      {
        "key": "Accept",
        "value": "application/json"
      }
    ],
    "url": {
      "raw": "{{baseUrl}}/api/v2/dynamic_content/items/:dynamic_content_item_id",
      "host": [
        "{{baseUrl}}"
      ],
      "path": [
        "api",
        "v2",
        "dynamic_content",
        "items",
        ":dynamic_content_item_id"
      ],
      "variable": [
        {
          "key": "dynamic_content_item_id",
          "value": "<integer>"
        }
      ]
    },
    "description": "The only attribute you can change is the name.\n\nTo add a variant to the item, or to update or delete the variants of the item, use the [Item Variants API](/api-reference/ticketing/ticket-management/dynamic_content_item_variants/#update-many-variants).\n\n#### Allowed For\n\n* Admins, Agents\n"
  },
  "response": [
    {
      "name": "Success response",
      "originalRequest": {
        "method": "PUT",
        "header": [
          {
            "description": "Added as a part of security scheme: basic",
            "key": "Authorization",
            "value": "Basic <credentials>"
          }
        ],
        "url": {
          "raw": "{{baseUrl}}/api/v2/dynamic_content/items/:dynamic_content_item_id",
          "host": [
            "{{baseUrl}}"
          ],
          "path": [
            "api",
            "v2",
            "dynamic_content",
            "items",
            ":dynamic_content_item_id"
          ],
          "variable": [
            {
              "key": "dynamic_content_item_id"
            }
          ]
        }
      },
      "status": "OK",
      "code": 200,
      "_postman_previewlanguage": "json",
      "header": [
        {
          "key": "Content-Type",
          "value": "application/json"
        }
      ],
      "cookie": [
      ],
      "body": "{\n  \"item\": {\n    \"name\": \"<string>\",\n    \"default_locale_id\": \"<integer>\",\n    \"variants\": [\n      {\n        \"content\": \"<string>\",\n        \"locale_id\": \"<integer>\",\n        \"active\": \"<boolean>\",\n        \"created_at\": \"<dateTime>\",\n        \"default\": \"<boolean>\",\n        \"id\": \"<integer>\",\n        \"outdated\": \"<boolean>\",\n        \"updated_at\": \"<dateTime>\",\n        \"url\": \"<string>\"\n      },\n      {\n        \"content\": \"<string>\",\n        \"locale_id\": \"<integer>\",\n        \"active\": \"<boolean>\",\n        \"created_at\": \"<dateTime>\",\n        \"default\": \"<boolean>\",\n        \"id\": \"<integer>\",\n        \"outdated\": \"<boolean>\",\n        \"updated_at\": \"<dateTime>\",\n        \"url\": \"<string>\"\n      }\n    ],\n    \"created_at\": \"<dateTime>\",\n    \"id\": \"<integer>\",\n    \"outdated\": \"<boolean>\",\n    \"placeholder\": \"<string>\",\n    \"updated_at\": \"<dateTime>\",\n    \"url\": \"<string>\"\n  }\n}"
    }
  ]
}