Chilkat Online Tools

delphiAx / Support API / Update Many Variants

Back to Collection Items

var
http: TChilkatHttp;
success: Integer;
resp: IChilkatHttpResponse;
sbResponseBody: TChilkatStringBuilder;
jResp: TChilkatJsonObject;
respStatusCode: Integer;
content: WideString;
locale_id: WideString;
active: WideString;
created_at: WideString;
default: WideString;
id: WideString;
outdated: WideString;
updated_at: WideString;
url: WideString;
i: Integer;
count_i: Integer;

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

http := TChilkatHttp.Create(Self);

http.BasicAuth := 1;
http.Login := 'login';
http.Password := 'password';

http.SetRequestHeader('Accept','application/json');

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
  begin
    Memo1.Lines.Add(http.LastErrorText);
    Exit;
  end;

sbResponseBody := TChilkatStringBuilder.Create(Self);
resp.GetBodySb(sbResponseBody.ControlInterface);

jResp := TChilkatJsonObject.Create(Self);
jResp.LoadSb(sbResponseBody.ControlInterface);
jResp.EmitCompact := 0;

Memo1.Lines.Add('Response Body:');
Memo1.Lines.Add(jResp.Emit());

respStatusCode := resp.StatusCode;
Memo1.Lines.Add('Response Status Code = ' + IntToStr(respStatusCode));
if (respStatusCode >= 400) then
  begin
    Memo1.Lines.Add('Response Header:');
    Memo1.Lines.Add(resp.Header);
    Memo1.Lines.Add('Failed.');

    Exit;
  end;

// 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');
while i < count_i do
  begin
    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;
  end;

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