Chilkat Online Tools

delphiAx / Zoom API / Create a role

Back to Collection Items

var
http: TChilkatHttp;
success: Integer;
req: TChilkatHttpRequest;
resp: IChilkatHttpResponse;
sbResponseBody: TChilkatStringBuilder;
jResp: TChilkatJsonObject;
respStatusCode: Integer;

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

http := TChilkatHttp.Create(Self);

req := TChilkatHttpRequest.Create(Self);
req.HttpVerb := 'POST';
req.Path := '/v2/roles';
req.ContentType := 'multipart/form-data';
req.AddParam('do ut','');

req.AddParam('description','do utin');

req.AddParam('privileges','do utin["Ut consectetur id","fugiat in non"]');

req.AddHeader('Authorization','Bearer <access_token>');

resp := http.SynchronousRequest('api.zoom.us',443,1,req.ControlInterface);
if (http.LastMethodSuccess = 0) then
  begin
    Memo1.Lines.Add(http.LastErrorText);
    Exit;
  end;

sbResponseBody := TChilkatStringBuilder.Create(Self);
resp.GetBodySb(sbResponseBody.ControlInterface);

jResp := TChilkatJsonObject.Create(Self);
jResp.LoadSb(sbResponseBody.ControlInterface);
jResp.EmitCompact := 0;

Memo1.Lines.Add('Response Body:');
Memo1.Lines.Add(jResp.Emit());

respStatusCode := resp.StatusCode;
Memo1.Lines.Add('Response Status Code = ' + IntToStr(respStatusCode));
if (respStatusCode >= 400) then
  begin
    Memo1.Lines.Add('Response Header:');
    Memo1.Lines.Add(resp.Header);
    Memo1.Lines.Add('Failed.');

    Exit;
  end;

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