autoit / Zoom API / Create a tracking field
Back to Collection Items
; This example assumes the Chilkat API to have been previously unlocked.
; See Global Unlock Sample for sample code.
$oHttp = ObjCreate("Chilkat.Http")
Local $bSuccess
$oReq = ObjCreate("Chilkat.HttpRequest")
$oReq.HttpVerb = "POST"
$oReq.Path = "/v2/tracking_fields"
$oReq.ContentType = "multipart/form-data"
$oReq.AddParam "field","anim incididunt qui ea"
$oReq.AddParam "required","anim incididunt qui eatrue"
$oReq.AddParam "visible","anim incididunt qui eatruetrue"
$oReq.AddParam "recommended_values","anim incididunt qui eatruetrue[""occaecat consectetur dolor"",""est""]"
$oReq.AddHeader "Authorization","Bearer <access_token>"
Local $oResp = $oHttp.SynchronousRequest("api.zoom.us",443,True,$oReq)
If ($oHttp.LastMethodSuccess = False) Then
ConsoleWrite($oHttp.LastErrorText & @CRLF)
Exit
EndIf
$oSbResponseBody = ObjCreate("Chilkat.StringBuilder")
$oResp.GetBodySb($oSbResponseBody)
$oJResp = ObjCreate("Chilkat.JsonObject")
$oJResp.LoadSb($oSbResponseBody)
$oJResp.EmitCompact = False
ConsoleWrite("Response Body:" & @CRLF)
ConsoleWrite($oJResp.Emit() & @CRLF)
Local $iRespStatusCode = $oResp.StatusCode
ConsoleWrite("Response Status Code = " & $iRespStatusCode & @CRLF)
If ($iRespStatusCode >= 400) Then
ConsoleWrite("Response Header:" & @CRLF)
ConsoleWrite($oResp.Header & @CRLF)
ConsoleWrite("Failed." & @CRLF)
Exit
EndIf
; 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
Local $strVal
Local $sId = $oJResp.StringOf("id")
Local $sField = $oJResp.StringOf("field")
Local $bRequired = $oJResp.BoolOf("required")
Local $bVisible = $oJResp.BoolOf("visible")
Local $i = 0
Local $iCount_i = $oJResp.SizeOfArray("recommended_values")
While $i < $iCount_i
$oJResp.I = $i
$strVal = $oJResp.StringOf("recommended_values[i]")
$i = $i + 1
Wend
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}"
}
]
}
