Chilkat Online Tools

TCL / Support API / Update Variant

Back to Collection Items

load ./chilkat.dll

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

set http [new_CkHttp]

CkHttp_put_BasicAuth $http 1
CkHttp_put_Login $http "login"
CkHttp_put_Password $http "password"

CkHttp_SetRequestHeader $http "Accept" "application/json"

# resp is a CkHttpResponse
set resp [CkHttp_QuickRequest $http "PUT" "https://example.zendesk.com/api/v2/dynamic_content/items/:dynamic_content_item_id/variants/:dynammic_content_variant_id"]
if {[CkHttp_get_LastMethodSuccess $http] == 0} then {
    puts [CkHttp_lastErrorText $http]
    delete_CkHttp $http
    exit
}

set sbResponseBody [new_CkStringBuilder]

CkHttpResponse_GetBodySb $resp $sbResponseBody

set jResp [new_CkJsonObject]

CkJsonObject_LoadSb $jResp $sbResponseBody
CkJsonObject_put_EmitCompact $jResp 0

puts "Response Body:"
puts [CkJsonObject_emit $jResp]

set respStatusCode [CkHttpResponse_get_StatusCode $resp]
puts "Response Status Code = $respStatusCode"
if {$respStatusCode >= 400} then {
    puts "Response Header:"
    puts [CkHttpResponse_header $resp]
    puts "Failed."
    delete_CkHttpResponse $resp

    delete_CkHttp $http
    delete_CkStringBuilder $sbResponseBody
    delete_CkJsonObject $jResp
    exit
}

delete_CkHttpResponse $resp

# Sample JSON response:
# (Sample code for parsing the JSON response is shown below)

# {
#   "variant": {
#     "content": "<string>",
#     "locale_id": "<integer>",
#     "active": "<boolean>",
#     "created_at": "<dateTime>",
#     "default": "<boolean>",
#     "id": "<integer>",
#     "outdated": "<boolean>",
#     "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

set Content [CkJsonObject_stringOf $jResp "variant.content"]
set Locale_id [CkJsonObject_stringOf $jResp "variant.locale_id"]
set Active [CkJsonObject_stringOf $jResp "variant.active"]
set Created_at [CkJsonObject_stringOf $jResp "variant.created_at"]
set Default [CkJsonObject_stringOf $jResp "variant.default"]
set Id [CkJsonObject_stringOf $jResp "variant.id"]
set Outdated [CkJsonObject_stringOf $jResp "variant.outdated"]
set Updated_at [CkJsonObject_stringOf $jResp "variant.updated_at"]
set v_Url [CkJsonObject_stringOf $jResp "variant.url"]

delete_CkHttp $http
delete_CkStringBuilder $sbResponseBody
delete_CkJsonObject $jResp

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/variants/:dynammic_content_variant_id

Postman Collection Item JSON

{
  "name": "Update Variant",
  "request": {
    "method": "PUT",
    "header": [
      {
        "key": "Accept",
        "value": "application/json"
      }
    ],
    "url": {
      "raw": "{{baseUrl}}/api/v2/dynamic_content/items/:dynamic_content_item_id/variants/:dynammic_content_variant_id",
      "host": [
        "{{baseUrl}}"
      ],
      "path": [
        "api",
        "v2",
        "dynamic_content",
        "items",
        ":dynamic_content_item_id",
        "variants",
        ":dynammic_content_variant_id"
      ],
      "variable": [
        {
          "key": "dynamic_content_item_id",
          "value": "<integer>"
        },
        {
          "key": "dynammic_content_variant_id",
          "value": "<integer>"
        }
      ]
    },
    "description": "Updates the specified variant. You don't need to include all the properties. If you just want to update content, for example, then include just that.\n\nYou can't switch the active state of the default variant of an item. Similarly, you can't switch the default to false if the variant is the default. You must make another variant default instead.\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/variants/:dynammic_content_variant_id",
          "host": [
            "{{baseUrl}}"
          ],
          "path": [
            "api",
            "v2",
            "dynamic_content",
            "items",
            ":dynamic_content_item_id",
            "variants",
            ":dynammic_content_variant_id"
          ],
          "variable": [
            {
              "key": "dynamic_content_item_id"
            },
            {
              "key": "dynammic_content_variant_id"
            }
          ]
        }
      },
      "status": "OK",
      "code": 200,
      "_postman_previewlanguage": "json",
      "header": [
        {
          "key": "Content-Type",
          "value": "application/json"
        }
      ],
      "cookie": [
      ],
      "body": "{\n  \"variant\": {\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}"
    }
  ]
}