Chilkat Online Tools

Ruby / Zoom API / Create a tracking field

Back to Collection Items

require 'chilkat'

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

http = Chilkat::CkHttp.new()

req = Chilkat::CkHttpRequest.new()
req.put_HttpVerb("POST")
req.put_Path("/v2/tracking_fields")
req.put_ContentType("multipart/form-data")
req.AddParam("field","anim incididunt qui ea")

req.AddParam("required","anim incididunt qui eatrue")

req.AddParam("visible","anim incididunt qui eatruetrue")

req.AddParam("recommended_values","anim incididunt qui eatruetrue[\"occaecat consectetur dolor\",\"est\"]")

req.AddHeader("Authorization","Bearer <access_token>")

# resp is a CkHttpResponse
resp = http.SynchronousRequest("api.zoom.us",443,true,req)
if (http.get_LastMethodSuccess() == false)
    print http.lastErrorText() + "\n";
    exit
end

sbResponseBody = Chilkat::CkStringBuilder.new()
resp.GetBodySb(sbResponseBody)

jResp = Chilkat::CkJsonObject.new()
jResp.LoadSb(sbResponseBody)
jResp.put_EmitCompact(false)

print "Response Body:" + "\n";
print jResp.emit() + "\n";

respStatusCode = resp.get_StatusCode()
print "Response Status Code = " + respStatusCode.to_s() + "\n";
if (respStatusCode >= 400)
    print "Response Header:" + "\n";
    print resp.header() + "\n";
    print "Failed." + "\n";

    exit
end

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

# {
#   "id": "s",
#   "field": "quis dolore",
#   "required": false,
#   "visible": true,
#   "recommended_values": [
#     "commodo",
#     "Lorem cillum ea veniam sed"
#   ]
# }

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

id = jResp.stringOf("id")
field = jResp.stringOf("field")
required = jResp.BoolOf("required")
visible = jResp.BoolOf("visible")
i = 0
count_i = jResp.SizeOfArray("recommended_values")
while i < count_i
    jResp.put_I(i)
    strVal = jResp.stringOf("recommended_values[i]")
    i = i + 1
end

Curl Command

curl -X POST
	-H "Authorization: Bearer <access_token>"
	-H "Content-Type: multipart/form-data"
	--form 'field=anim incididunt qui ea'
	--form 'required=anim incididunt qui eatrue'
	--form 'visible=anim incididunt qui eatruetrue'
	--form 'recommended_values=anim incididunt qui eatruetrue["occaecat consectetur dolor","est"]'
https://api.zoom.us/v2/tracking_fields

Postman Collection Item JSON

{
  "name": "Create a tracking field",
  "request": {
    "auth": {
      "type": "oauth2"
    },
    "method": "POST",
    "header": [
      {
        "key": "Content-Type",
        "value": "multipart/form-data"
      }
    ],
    "body": {
      "mode": "formdata",
      "formdata": [
        {
          "key": "field",
          "value": "anim incididunt qui ea",
          "description": "Label/ Name for the tracking field.",
          "type": "text"
        },
        {
          "key": "required",
          "value": "true",
          "description": "Tracking Field Required",
          "type": "text"
        },
        {
          "key": "visible",
          "value": "true",
          "description": "Tracking Field Visible",
          "type": "text"
        },
        {
          "key": "recommended_values",
          "value": "[\"occaecat consectetur dolor\",\"est\"]",
          "description": "Array of recommended values",
          "type": "text"
        }
      ]
    },
    "url": {
      "raw": "{{baseUrl}}/tracking_fields",
      "host": [
        "{{baseUrl}}"
      ],
      "path": [
        "tracking_fields"
      ]
    },
    "description": "Use this API to create a new [tracking field](https://support.zoom.us/hc/en-us/articles/115000293426-Scheduling-Tracking-Fields). Tracking fields let you analyze usage by various fields within an organization. When scheduling a meeting, tracking fields will be included in the meeting options. \n\n**Scope:** `tracking_fields:write:admin` <br> **[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `Light` \n\n**Prerequisites:** \n* A Business, Education, API or higher plan."
  },
  "response": [
    {
      "name": "**HTTP Status Code:** `201`<br>\nTracking Field created",
      "originalRequest": {
        "method": "POST",
        "header": [
          {
            "description": "Added as a part of security scheme: oauth2",
            "key": "Authorization",
            "value": "<token>"
          }
        ],
        "body": {
          "mode": "formdata",
          "formdata": [
            {
              "key": "field",
              "value": "dolore adipisicing",
              "description": "Label/ Name for the tracking field.",
              "type": "text"
            },
            {
              "key": "required",
              "value": "false",
              "description": "Tracking Field Required",
              "type": "text"
            },
            {
              "key": "visible",
              "value": "false",
              "description": "Tracking Field Visible",
              "type": "text"
            },
            {
              "key": "recommended_values",
              "value": "[\"labore\",\"Duis qui\"]",
              "description": "Array of recommended values",
              "type": "text"
            }
          ]
        },
        "url": {
          "raw": "{{baseUrl}}/tracking_fields",
          "host": [
            "{{baseUrl}}"
          ],
          "path": [
            "tracking_fields"
          ]
        }
      },
      "status": "Created",
      "code": 201,
      "_postman_previewlanguage": "json",
      "header": [
        {
          "key": "Content-Location",
          "value": "quis officia in reprehenderit",
          "description": "Location of created tracking field"
        },
        {
          "key": "Content-Type",
          "value": "application/json"
        }
      ],
      "cookie": [
      ],
      "body": "{\n \"id\": \"s\",\n \"field\": \"quis dolore\",\n \"required\": false,\n \"visible\": true,\n \"recommended_values\": [\n  \"commodo\",\n  \"Lorem cillum ea veniam sed\"\n ]\n}"
    }
  ]
}