TCL / Zoom API / Create a tracking field
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]
set req [new_CkHttpRequest]
CkHttpRequest_put_HttpVerb $req "POST"
CkHttpRequest_put_Path $req "/v2/tracking_fields"
CkHttpRequest_put_ContentType $req "multipart/form-data"
CkHttpRequest_AddParam $req "field" "anim incididunt qui ea"
CkHttpRequest_AddParam $req "required" "anim incididunt qui eatrue"
CkHttpRequest_AddParam $req "visible" "anim incididunt qui eatruetrue"
CkHttpRequest_AddParam $req "recommended_values" "anim incididunt qui eatruetrue[\"occaecat consectetur dolor\",\"est\"]"
CkHttpRequest_AddHeader $req "Authorization" "Bearer <access_token>"
# resp is a CkHttpResponse
set resp [CkHttp_SynchronousRequest $http "api.zoom.us" 443 1 $req]
if {[CkHttp_get_LastMethodSuccess $http] == 0} then {
puts [CkHttp_lastErrorText $http]
delete_CkHttp $http
delete_CkHttpRequest $req
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_CkHttpRequest $req
delete_CkStringBuilder $sbResponseBody
delete_CkJsonObject $jResp
exit
}
delete_CkHttpResponse $resp
# 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
set id [CkJsonObject_stringOf $jResp "id"]
set field [CkJsonObject_stringOf $jResp "field"]
set required [CkJsonObject_BoolOf $jResp "required"]
set visible [CkJsonObject_BoolOf $jResp "visible"]
set i 0
set count_i [CkJsonObject_SizeOfArray $jResp "recommended_values"]
while {$i < $count_i} {
CkJsonObject_put_I $jResp $i
set strVal [CkJsonObject_stringOf $jResp "recommended_values[i]"]
set i [expr $i + 1]
}
delete_CkHttp $http
delete_CkHttpRequest $req
delete_CkStringBuilder $sbResponseBody
delete_CkJsonObject $jResp
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}"
}
]
}