Chilkat Online Tools

Objective-C / Zoom API / Create a tracking field

Back to Collection Items

#import <CkoHttp.h>
#import <CkoHttpRequest.h>
#import <CkoHttpResponse.h>
#import <CkoStringBuilder.h>
#import <CkoJsonObject.h>
#import <NSString.h>

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

CkoHttp *http = [[CkoHttp alloc] init];
BOOL success;

CkoHttpRequest *req = [[CkoHttpRequest alloc] init];
req.HttpVerb = @"POST";
req.Path = @"/v2/tracking_fields";
req.ContentType = @"multipart/form-data";
[req AddParam: @"field" value: @"anim incididunt qui ea"];

[req AddParam: @"required" value: @"anim incididunt qui eatrue"];

[req AddParam: @"visible" value: @"anim incididunt qui eatruetrue"];

[req AddParam: @"recommended_values" value: @"anim incididunt qui eatruetrue[\"occaecat consectetur dolor\",\"est\"]"];

[req AddHeader: @"Authorization" value: @"Bearer <access_token>"];

CkoHttpResponse *resp = [http SynchronousRequest: @"api.zoom.us" port: [NSNumber numberWithInt: 443] ssl: YES req: req];
if (http.LastMethodSuccess == NO) {
    NSLog(@"%@",http.LastErrorText);
    return;
}

CkoStringBuilder *sbResponseBody = [[CkoStringBuilder alloc] init];
[resp GetBodySb: sbResponseBody];

CkoJsonObject *jResp = [[CkoJsonObject alloc] init];
[jResp LoadSb: sbResponseBody];
jResp.EmitCompact = NO;

NSLog(@"%@",@"Response Body:");
NSLog(@"%@",[jResp Emit]);

int respStatusCode = [resp.StatusCode intValue];
NSLog(@"%@%d",@"Response Status Code = ",respStatusCode);
if (respStatusCode >= 400) {
    NSLog(@"%@",@"Response Header:");
    NSLog(@"%@",resp.Header);
    NSLog(@"%@",@"Failed.");

    return;
}

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

NSString *strVal = 0;

NSString *id = [jResp StringOf: @"id"];
NSString *field = [jResp StringOf: @"field"];
BOOL required = [jResp BoolOf: @"required"];
BOOL visible = [jResp BoolOf: @"visible"];
int i = 0;
int count_i = [[jResp SizeOfArray: @"recommended_values"] intValue];
while (i < count_i) {
    jResp.I = [NSNumber numberWithInt: i];
    strVal = [jResp StringOf: @"recommended_values[i]"];
    i = i + 1;
}

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}"
    }
  ]
}