Chilkat Online Tools

.NET Core C# / Support API / Create Variant

Back to Collection Items

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

Chilkat.Http http = new Chilkat.Http();
bool success;

http.BasicAuth = true;
http.Login = "login";
http.Password = "password";

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

Chilkat.HttpResponse resp = http.QuickRequest("POST","https://example.zendesk.com/api/v2/dynamic_content/items/:dynamic_content_item_id/variants");
if (http.LastMethodSuccess == false) {
    Debug.WriteLine(http.LastErrorText);
    return;
}

Chilkat.StringBuilder sbResponseBody = new Chilkat.StringBuilder();
resp.GetBodySb(sbResponseBody);

Chilkat.JsonObject jResp = new Chilkat.JsonObject();
jResp.LoadSb(sbResponseBody);
jResp.EmitCompact = false;

Debug.WriteLine("Response Body:");
Debug.WriteLine(jResp.Emit());

int respStatusCode = resp.StatusCode;
Debug.WriteLine("Response Status Code = " + Convert.ToString(respStatusCode));
if (respStatusCode >= 400) {
    Debug.WriteLine("Response Header:");
    Debug.WriteLine(resp.Header);
    Debug.WriteLine("Failed.");

    return;
}

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

string Content = jResp.StringOf("variant.content");
string Locale_id = jResp.StringOf("variant.locale_id");
string Active = jResp.StringOf("variant.active");
string Created_at = jResp.StringOf("variant.created_at");
string Default = jResp.StringOf("variant.default");
string Id = jResp.StringOf("variant.id");
string Outdated = jResp.StringOf("variant.outdated");
string Updated_at = jResp.StringOf("variant.updated_at");
string v_Url = jResp.StringOf("variant.url");

Curl Command

curl  -u login:password -X POST
	-H "Accept: application/json"
https://example.zendesk.com/api/v2/dynamic_content/items/:dynamic_content_item_id/variants

Postman Collection Item JSON

{
  "name": "Create Variant",
  "request": {
    "method": "POST",
    "header": [
      {
        "key": "Accept",
        "value": "application/json"
      }
    ],
    "url": {
      "raw": "{{baseUrl}}/api/v2/dynamic_content/items/:dynamic_content_item_id/variants",
      "host": [
        "{{baseUrl}}"
      ],
      "path": [
        "api",
        "v2",
        "dynamic_content",
        "items",
        ":dynamic_content_item_id",
        "variants"
      ],
      "variable": [
        {
          "key": "dynamic_content_item_id",
          "value": "<integer>"
        }
      ]
    },
    "description": "You can only create one variant for each locale id. If a locale variant already exists, the request is rejected.\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/:dynamic_content_item_id/variants",
          "host": [
            "{{baseUrl}}"
          ],
          "path": [
            "api",
            "v2",
            "dynamic_content",
            "items",
            ":dynamic_content_item_id",
            "variants"
          ],
          "variable": [
            {
              "key": "dynamic_content_item_id"
            }
          ]
        }
      },
      "status": "Created",
      "code": 201,
      "_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}"
    }
  ]
}