Chilkat Online Tools

Powershell / Zoom API / Update a tracking field

Back to Collection Items

Add-Type -Path "C:\chilkat\ChilkatDotNet47-x64\ChilkatDotNet47.dll"

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

$http = New-Object Chilkat.Http

$req = New-Object Chilkat.HttpRequest
$req.HttpVerb = "PATCH"
$req.Path = "/v2/tracking_fields/:fieldId"
$req.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 = $http.SynchronousRequest("api.zoom.us",443,$true,$req)
if ($http.LastMethodSuccess -eq $false) {
    $($http.LastErrorText)
    exit
}

$respStatusCode = $resp.StatusCode
$("Response Status Code = " + $respStatusCode)
if ($respStatusCode -ne 204) {
    $("Response Header:")
    $($resp.Header)
    $("Response Body:")
    $($resp.BodyStr)
    $("Failed.")

    exit
}

$("Success.")

Curl Command

curl -X PATCH
	-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/:fieldId

Postman Collection Item JSON

{
  "name": "Update a tracking field",
  "request": {
    "auth": {
      "type": "oauth2"
    },
    "method": "PATCH",
    "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/:fieldId",
      "host": [
        "{{baseUrl}}"
      ],
      "path": [
        "tracking_fields",
        ":fieldId"
      ],
      "variable": [
        {
          "key": "fieldId",
          "value": "quis officia in reprehenderit",
          "description": "(Required) The Tracking Field ID"
        }
      ]
    },
    "description": "Use this API to update a [tracking field](https://support.zoom.us/hc/en-us/articles/115000293426-Scheduling-Tracking-Fields). \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:** `204`<br>\nTracking Field updated",
      "originalRequest": {
        "method": "PATCH",
        "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/:fieldId",
          "host": [
            "{{baseUrl}}"
          ],
          "path": [
            "tracking_fields",
            ":fieldId"
          ],
          "variable": [
            {
              "key": "fieldId",
              "value": "quis officia in reprehenderit",
              "description": "(Required) The Tracking Field ID"
            }
          ]
        }
      },
      "status": "No Content",
      "code": 204,
      "_postman_previewlanguage": "text",
      "header": [
        {
          "key": "Content-Type",
          "value": "text/plain"
        }
      ],
      "cookie": [
      ],
      "body": ""
    },
    {
      "name": "**HTTP Status Code:** `404`<br>\nTracking Field not found",
      "originalRequest": {
        "method": "PATCH",
        "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/:fieldId",
          "host": [
            "{{baseUrl}}"
          ],
          "path": [
            "tracking_fields",
            ":fieldId"
          ],
          "variable": [
            {
              "key": "fieldId",
              "value": "quis officia in reprehenderit",
              "description": "(Required) The Tracking Field ID"
            }
          ]
        }
      },
      "status": "Not Found",
      "code": 404,
      "_postman_previewlanguage": "text",
      "header": [
        {
          "key": "Content-Type",
          "value": "text/plain"
        }
      ],
      "cookie": [
      ],
      "body": ""
    }
  ]
}