Chilkat Online Tools

unicodeC / Zoom API / Create a role

Back to Collection Items

#include <C_CkHttpW.h>
#include <C_CkHttpRequestW.h>
#include <C_CkHttpResponseW.h>
#include <C_CkStringBuilderW.h>
#include <C_CkJsonObjectW.h>

void ChilkatSample(void)
    {
    HCkHttpW http;
    BOOL success;
    HCkHttpRequestW req;
    HCkHttpResponseW resp;
    HCkStringBuilderW sbResponseBody;
    HCkJsonObjectW jResp;
    int respStatusCode;

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

    http = CkHttpW_Create();

    req = CkHttpRequestW_Create();
    CkHttpRequestW_putHttpVerb(req,L"POST");
    CkHttpRequestW_putPath(req,L"/v2/roles");
    CkHttpRequestW_putContentType(req,L"multipart/form-data");
    CkHttpRequestW_AddParam(req,L"do ut",L"");

    CkHttpRequestW_AddParam(req,L"description",L"do utin");

    CkHttpRequestW_AddParam(req,L"privileges",L"do utin[\"Ut consectetur id\",\"fugiat in non\"]");

    CkHttpRequestW_AddHeader(req,L"Authorization",L"Bearer <access_token>");

    resp = CkHttpW_SynchronousRequest(http,L"api.zoom.us",443,TRUE,req);
    if (CkHttpW_getLastMethodSuccess(http) == FALSE) {
        wprintf(L"%s\n",CkHttpW_lastErrorText(http));
        CkHttpW_Dispose(http);
        CkHttpRequestW_Dispose(req);
        return;
    }

    sbResponseBody = CkStringBuilderW_Create();
    CkHttpResponseW_GetBodySb(resp,sbResponseBody);

    jResp = CkJsonObjectW_Create();
    CkJsonObjectW_LoadSb(jResp,sbResponseBody);
    CkJsonObjectW_putEmitCompact(jResp,FALSE);

    wprintf(L"Response Body:\n");
    wprintf(L"%s\n",CkJsonObjectW_emit(jResp));

    respStatusCode = CkHttpResponseW_getStatusCode(resp);
    wprintf(L"Response Status Code = %d\n",respStatusCode);
    if (respStatusCode >= 400) {
        wprintf(L"Response Header:\n");
        wprintf(L"%s\n",CkHttpResponseW_header(resp));
        wprintf(L"Failed.\n");
        CkHttpResponseW_Dispose(resp);
        CkHttpW_Dispose(http);
        CkHttpRequestW_Dispose(req);
        CkStringBuilderW_Dispose(sbResponseBody);
        CkJsonObjectW_Dispose(jResp);
        return;
    }

    CkHttpResponseW_Dispose(resp);


    CkHttpW_Dispose(http);
    CkHttpRequestW_Dispose(req);
    CkStringBuilderW_Dispose(sbResponseBody);
    CkJsonObjectW_Dispose(jResp);

    }

Curl Command

curl -X POST
	-H "Authorization: Bearer <access_token>"
	-H "Content-Type: multipart/form-data"
	--form 'name=do ut'
	--form 'description=do utin'
	--form 'privileges=do utin["Ut consectetur id","fugiat in non"]'
https://api.zoom.us/v2/roles

Postman Collection Item JSON

{
  "name": "Create a role",
  "request": {
    "auth": {
      "type": "oauth2"
    },
    "method": "POST",
    "header": [
      {
        "key": "Content-Type",
        "value": "multipart/form-data"
      }
    ],
    "body": {
      "mode": "formdata",
      "formdata": [
        {
          "key": "name",
          "value": "do ut",
          "description": "Name of the role.",
          "type": "text"
        },
        {
          "key": "description",
          "value": "in",
          "description": "Description of the role.",
          "type": "text"
        },
        {
          "key": "privileges",
          "value": "[\"Ut consectetur id\",\"fugiat in non\"]",
          "description": "Privileges assigned to the role. Can be one or a combination of [these permissions](https://marketplace.zoom.us/docs/api-reference/other-references/privileges).",
          "type": "text"
        }
      ]
    },
    "url": {
      "raw": "{{baseUrl}}/roles",
      "host": [
        "{{baseUrl}}"
      ],
      "path": [
        "roles"
      ]
    },
    "description": "Each Zoom user automatically has a role which can either be owner, administrator, or a member. \n\n**Pre-requisite:**<br>\n* Pro or higher plan.\n* For setting the initial role, you must be the Account Owner.<br>\n* For subsequent role management, you must be the Account Owner or user with role management permissions.<br>\n**Scopes:** `role:write:admin`<br>\n \n **[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `Light`"
  },
  "response": [
    {
      "name": "**Status Code:** `200`<br>\nYou do not have the permission to create a role.",
      "originalRequest": {
        "method": "POST",
        "header": [
          {
            "description": "Added as a part of security scheme: oauth2",
            "key": "Authorization",
            "value": "<token>"
          }
        ],
        "body": {
          "mode": "formdata",
          "formdata": [
            {
              "key": "name",
              "value": "ea nostrud",
              "description": "Name of the role.",
              "type": "text"
            },
            {
              "key": "description",
              "value": "pariatur fugiat",
              "description": "Description of the role.",
              "type": "text"
            },
            {
              "key": "privileges",
              "value": "[\"aliq\",\"Duis nostrud exercitation irure dolore\"]",
              "description": "Privileges assigned to the role. Can be one or a combination of [these permissions](https://marketplace.zoom.us/docs/api-reference/other-references/privileges).",
              "type": "text"
            }
          ]
        },
        "url": {
          "raw": "{{baseUrl}}/roles",
          "host": [
            "{{baseUrl}}"
          ],
          "path": [
            "roles"
          ]
        }
      },
      "status": "OK",
      "code": 200,
      "_postman_previewlanguage": "json",
      "header": [
        {
          "key": "Content-Type",
          "value": "application/json"
        }
      ],
      "cookie": [
      ],
      "body": "{}"
    },
    {
      "name": "**Status Code:** `201`<br>\nRole created.",
      "originalRequest": {
        "method": "POST",
        "header": [
          {
            "description": "Added as a part of security scheme: oauth2",
            "key": "Authorization",
            "value": "<token>"
          }
        ],
        "body": {
          "mode": "formdata",
          "formdata": [
            {
              "key": "name",
              "value": "ea nostrud",
              "description": "Name of the role.",
              "type": "text"
            },
            {
              "key": "description",
              "value": "pariatur fugiat",
              "description": "Description of the role.",
              "type": "text"
            },
            {
              "key": "privileges",
              "value": "[\"aliq\",\"Duis nostrud exercitation irure dolore\"]",
              "description": "Privileges assigned to the role. Can be one or a combination of [these permissions](https://marketplace.zoom.us/docs/api-reference/other-references/privileges).",
              "type": "text"
            }
          ]
        },
        "url": {
          "raw": "{{baseUrl}}/roles",
          "host": [
            "{{baseUrl}}"
          ],
          "path": [
            "roles"
          ]
        }
      },
      "status": "Created",
      "code": 201,
      "_postman_previewlanguage": "json",
      "header": [
        {
          "key": "Content-Type",
          "value": "application/json"
        }
      ],
      "cookie": [
      ],
      "body": "{\n \"id\": \"esse qui Lorem voluptate\",\n \"name\": \"nostrud laboris\",\n \"description\": \"cillum ipsum\",\n \"total_members\": 28079344,\n \"privileges\": [\n  \"elit\",\n  \"sint culpa cillum\"\n ]\n}"
    },
    {
      "name": "**Error Code:** `300`<br>\nThe name field cannot be empty.",
      "originalRequest": {
        "method": "POST",
        "header": [
          {
            "description": "Added as a part of security scheme: oauth2",
            "key": "Authorization",
            "value": "<token>"
          }
        ],
        "body": {
          "mode": "formdata",
          "formdata": [
            {
              "key": "name",
              "value": "ea nostrud",
              "description": "Name of the role.",
              "type": "text"
            },
            {
              "key": "description",
              "value": "pariatur fugiat",
              "description": "Description of the role.",
              "type": "text"
            },
            {
              "key": "privileges",
              "value": "[\"aliq\",\"Duis nostrud exercitation irure dolore\"]",
              "description": "Privileges assigned to the role. Can be one or a combination of [these permissions](https://marketplace.zoom.us/docs/api-reference/other-references/privileges).",
              "type": "text"
            }
          ]
        },
        "url": {
          "raw": "{{baseUrl}}/roles",
          "host": [
            "{{baseUrl}}"
          ],
          "path": [
            "roles"
          ]
        }
      },
      "status": "Multiple Choices",
      "code": 300,
      "_postman_previewlanguage": "text",
      "header": [
        {
          "key": "Content-Type",
          "value": "text/plain"
        }
      ],
      "cookie": [
      ],
      "body": ""
    }
  ]
}