Chilkat Online Tools

Perl / Support API / Update Item

Back to Collection Items

use chilkat();

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

$http = chilkat::CkHttp->new();

$http->put_BasicAuth(1);
$http->put_Login("login");
$http->put_Password("password");

$http->SetRequestHeader("Accept","application/json");

# resp is a HttpResponse
$resp = $http->QuickRequest("PUT","https://example.zendesk.com/api/v2/dynamic_content/items/:dynamic_content_item_id");
if ($http->get_LastMethodSuccess() == 0) {
    print $http->lastErrorText() . "\r\n";
    exit;
}

$sbResponseBody = chilkat::CkStringBuilder->new();
$resp->GetBodySb($sbResponseBody);

$jResp = chilkat::CkJsonObject->new();
$jResp->LoadSb($sbResponseBody);
$jResp->put_EmitCompact(0);

print "Response Body:" . "\r\n";
print $jResp->emit() . "\r\n";

$respStatusCode = $resp->get_StatusCode();
print "Response Status Code = " . $respStatusCode . "\r\n";
if ($respStatusCode >= 400) {
    print "Response Header:" . "\r\n";
    print $resp->header() . "\r\n";
    print "Failed." . "\r\n";

    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 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}"
    }
  ]
}