Chilkat Online Tools

VBScript / Support API / Update Many Variants

Back to Collection Items

Dim fso, outFile
Set fso = CreateObject("Scripting.FileSystemObject")
Set outFile = fso.CreateTextFile("output.txt", True)

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

set http = CreateObject("Chilkat_9_5_0.Http")

http.BasicAuth = 1
http.Login = "login"
http.Password = "password"

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

' resp is a Chilkat_9_5_0.HttpResponse
Set resp = http.QuickRequest("PUT","https://example.zendesk.com/api/v2/dynamic_content/items/:dynamic_content_item_id/variants/update_many")
If (http.LastMethodSuccess = 0) Then
    outFile.WriteLine(http.LastErrorText)
    WScript.Quit
End If

set sbResponseBody = CreateObject("Chilkat_9_5_0.StringBuilder")
success = resp.GetBodySb(sbResponseBody)

set jResp = CreateObject("Chilkat_9_5_0.JsonObject")
success = jResp.LoadSb(sbResponseBody)
jResp.EmitCompact = 0

outFile.WriteLine("Response Body:")
outFile.WriteLine(jResp.Emit())

respStatusCode = resp.StatusCode
outFile.WriteLine("Response Status Code = " & respStatusCode)
If (respStatusCode >= 400) Then
    outFile.WriteLine("Response Header:")
    outFile.WriteLine(resp.Header)
    outFile.WriteLine("Failed.")

    WScript.Quit
End If

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

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

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

i = 0
count_i = jResp.SizeOfArray("variants")
Do While i < count_i
    jResp.I = i
    content = jResp.StringOf("variants[i].content")
    locale_id = jResp.StringOf("variants[i].locale_id")
    active = jResp.StringOf("variants[i].active")
    created_at = jResp.StringOf("variants[i].created_at")
    default = jResp.StringOf("variants[i].default")
    id = jResp.StringOf("variants[i].id")
    outdated = jResp.StringOf("variants[i].outdated")
    updated_at = jResp.StringOf("variants[i].updated_at")
    url = jResp.StringOf("variants[i].url")
    i = i + 1
Loop

outFile.Close

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/update_many

Postman Collection Item JSON

{
  "name": "Update Many Variants",
  "request": {
    "method": "PUT",
    "header": [
      {
        "key": "Accept",
        "value": "application/json"
      }
    ],
    "url": {
      "raw": "{{baseUrl}}/api/v2/dynamic_content/items/:dynamic_content_item_id/variants/update_many",
      "host": [
        "{{baseUrl}}"
      ],
      "path": [
        "api",
        "v2",
        "dynamic_content",
        "items",
        ":dynamic_content_item_id",
        "variants",
        "update_many"
      ],
      "variable": [
        {
          "key": "dynamic_content_item_id",
          "value": "<integer>"
        }
      ]
    },
    "description": "Updates one or more variants. See [Update Variant](/api-reference/ticketing/ticket-management/dynamic_content_item_variants/#update-variant).\n\nYou must specify the variants by id in the body. To get the variant ids, see [List Variants](/api-reference/ticketing/ticket-management/dynamic_content_item_variants/#list-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/variants/update_many",
          "host": [
            "{{baseUrl}}"
          ],
          "path": [
            "api",
            "v2",
            "dynamic_content",
            "items",
            ":dynamic_content_item_id",
            "variants",
            "update_many"
          ],
          "variable": [
            {
              "key": "dynamic_content_item_id"
            }
          ]
        }
      },
      "status": "OK",
      "code": 200,
      "_postman_previewlanguage": "json",
      "header": [
        {
          "key": "Content-Type",
          "value": "application/json"
        }
      ],
      "cookie": [
      ],
      "body": "{\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}"
    }
  ]
}