Chilkat Online Tools

Python / Support API / Create Item

Back to Collection Items

import sys
import chilkat

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

http = chilkat.CkHttp()

http.put_BasicAuth(True)
http.put_Login("login")
http.put_Password("password")

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

# resp is a CkHttpResponse
resp = http.QuickRequest("POST","https://example.zendesk.com/api/v2/dynamic_content/items")
if (http.get_LastMethodSuccess() == False):
    print(http.lastErrorText())
    sys.exit()

sbResponseBody = chilkat.CkStringBuilder()
resp.GetBodySb(sbResponseBody)

jResp = chilkat.CkJsonObject()
jResp.LoadSb(sbResponseBody)
jResp.put_EmitCompact(False)

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

respStatusCode = resp.get_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.put_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 POST
	-H "Accept: application/json"
https://example.zendesk.com/api/v2/dynamic_content/items

Postman Collection Item JSON

{
  "name": "Create Item",
  "request": {
    "method": "POST",
    "header": [
      {
        "key": "Accept",
        "value": "application/json"
      }
    ],
    "url": {
      "raw": "{{baseUrl}}/api/v2/dynamic_content/items",
      "host": [
        "{{baseUrl}}"
      ],
      "path": [
        "api",
        "v2",
        "dynamic_content",
        "items"
      ]
    },
    "description": "Create a new content item, with one or more variants in the item's `variants` array. See [Specifying item variants](#specifying-item-variants).\n\nThe `default_locale_id` and variant `locale_id` values must be one of the locales the account has active. You can get the list with the [List Locales](/api-reference/ticketing/account-configuration/locales/#list-locales) endpoint.\n\n#### Allowed For\n\n* Admins, Agents\n"
  },
  "response": [
    {
      "name": "Created response",
      "originalRequest": {
        "method": "POST",
        "header": [
          {
            "description": "Added as a part of security scheme: basic",
            "key": "Authorization",
            "value": "Basic <credentials>"
          }
        ],
        "url": {
          "raw": "{{baseUrl}}/api/v2/dynamic_content/items",
          "host": [
            "{{baseUrl}}"
          ],
          "path": [
            "api",
            "v2",
            "dynamic_content",
            "items"
          ]
        }
      },
      "status": "Created",
      "code": 201,
      "_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}"
    }
  ]
}