Chilkat Online Tools

Powershell / Zoom API / Update role information

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/roles/:roleId"
$req.ContentType = "multipart/form-data"
$req.AddParam("id","do Lorem est dolore")

$req.AddParam("do Lorem est doloreUt ipsum adipisicing eu","")

$req.AddParam("description","do Lorem est doloreUt ipsum adipisicing euincididunt")

$req.AddParam("total_members","do Lorem est doloreUt ipsum adipisicing euincididunt-75613664")

$req.AddParam("privileges","do Lorem est doloreUt ipsum adipisicing euincididunt-75613664[`"elit veniam tempor`",`"anim laboris Excepteur`"]")

$req.AddParam("sub_account_privileges","do Lorem est doloreUt ipsum adipisicing euincididunt-75613664[`"elit veniam tempor`",`"anim laboris Excepteur`"]{`"second_level`":-31284422}")

$req.AddHeader("Authorization","Bearer <access_token>")

$resp = $http.SynchronousRequest("api.zoom.us",443,$true,$req)
if ($http.LastMethodSuccess -eq $false) {
    $($http.LastErrorText)
    exit
}

$sbResponseBody = New-Object Chilkat.StringBuilder
$resp.GetBodySb($sbResponseBody)

$jResp = New-Object Chilkat.JsonObject
$jResp.LoadSb($sbResponseBody)
$jResp.EmitCompact = $false

$("Response Body:")
$($jResp.Emit())

$respStatusCode = $resp.StatusCode
$("Response Status Code = " + $respStatusCode)
if ($respStatusCode -ge 400) {
    $("Response Header:")
    $($resp.Header)
    $("Failed.")

    exit
}

Curl Command

curl -X PATCH
	-H "Authorization: Bearer <access_token>"
	-H "Content-Type: multipart/form-data"
	--form 'id=do Lorem est dolore'
	--form 'name=do Lorem est doloreUt ipsum adipisicing eu'
	--form 'description=do Lorem est doloreUt ipsum adipisicing euincididunt'
	--form 'total_members=do Lorem est doloreUt ipsum adipisicing euincididunt-75613664'
	--form 'privileges=do Lorem est doloreUt ipsum adipisicing euincididunt-75613664["elit veniam tempor","anim laboris Excepteur"]'
	--form 'sub_account_privileges=do Lorem est doloreUt ipsum adipisicing euincididunt-75613664["elit veniam tempor","anim laboris Excepteur"]{"second_level":-31284422}'
https://api.zoom.us/v2/roles/:roleId

Postman Collection Item JSON

{
  "name": "Update role information",
  "request": {
    "auth": {
      "type": "oauth2"
    },
    "method": "PATCH",
    "header": [
      {
        "key": "Content-Type",
        "value": "multipart/form-data"
      }
    ],
    "body": {
      "mode": "formdata",
      "formdata": [
        {
          "key": "id",
          "value": "do Lorem est dolore",
          "description": "Role Id.",
          "type": "text"
        },
        {
          "key": "name",
          "value": "Ut ipsum adipisicing eu",
          "description": "Name of the role.",
          "type": "text"
        },
        {
          "key": "description",
          "value": "incididunt",
          "description": "Description of the role.",
          "type": "text"
        },
        {
          "key": "total_members",
          "value": "-75613664",
          "description": "Total members assigned to that role.",
          "type": "text"
        },
        {
          "key": "privileges",
          "value": "[\"elit veniam tempor\",\"anim laboris Excepteur\"]",
          "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).\n",
          "type": "text"
        },
        {
          "key": "sub_account_privileges",
          "value": "{\"second_level\":-31284422}",
          "description": "This field will only be displayed to accounts that are enrolled in the partner plan and follow master accounts and sub accounts structure.",
          "type": "text"
        }
      ]
    },
    "url": {
      "raw": "{{baseUrl}}/roles/:roleId",
      "host": [
        "{{baseUrl}}"
      ],
      "path": [
        "roles",
        ":roleId"
      ],
      "variable": [
        {
          "key": "roleId",
          "value": "quis officia in reprehenderit",
          "description": "(Required) Role Id"
        }
      ]
    },
    "description": "Each Zoom user automatically has a [role](https://support.zoom.us/hc/en-us/articles/115001078646-Role-Based-Access-Control) which can either be owner, administrator, or a member. Account Owners and users with edit privileges for Role management can add customized roles with a list.\n\nUse this API to change the privileges, name and description of a specific role.<br>\n**Pre-requisite:**<br>\n* A Pro or higher plan.<br>\n* For role management and updates, you must be the Account Owner or user with role management permissions.<br>**Scopes:** `role:write:admin`<br>\n \n **[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `Light`"
  },
  "response": [
    {
      "name": "**Error Code:** `200`<br>\nThe account must be a paid account to update the role.",
      "originalRequest": {
        "method": "PATCH",
        "header": [
          {
            "description": "Added as a part of security scheme: oauth2",
            "key": "Authorization",
            "value": "<token>"
          }
        ],
        "body": {
          "mode": "formdata",
          "formdata": [
            {
              "key": "id",
              "value": "dolore est",
              "description": "Role Id.",
              "type": "text"
            },
            {
              "key": "name",
              "value": "enim esse",
              "description": "Name of the role.",
              "type": "text"
            },
            {
              "key": "description",
              "value": "elit veniam",
              "description": "Description of the role.",
              "type": "text"
            },
            {
              "key": "total_members",
              "value": "-91821999",
              "description": "Total members assigned to that role.",
              "type": "text"
            },
            {
              "key": "privileges",
              "value": "[\"fugiat officia dolore laboris Ut\",\"adipisicing\"]",
              "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).\n",
              "type": "text"
            },
            {
              "key": "sub_account_privileges",
              "value": "{\"second_level\":96157102}",
              "description": "This field will only be displayed to accounts that are enrolled in the partner plan and follow master accounts and sub accounts structure.",
              "type": "text"
            }
          ]
        },
        "url": {
          "raw": "{{baseUrl}}/roles/:roleId",
          "host": [
            "{{baseUrl}}"
          ],
          "path": [
            "roles",
            ":roleId"
          ],
          "variable": [
            {
              "key": "roleId",
              "value": "quis officia in reprehenderit",
              "description": "(Required) Role Id"
            }
          ]
        }
      },
      "status": "OK",
      "code": 200,
      "_postman_previewlanguage": "json",
      "header": [
        {
          "key": "Content-Type",
          "value": "application/json"
        }
      ],
      "cookie": [
      ],
      "body": "{}"
    },
    {
      "name": "**Status Code:** `400`<br>\nRole updated.",
      "originalRequest": {
        "method": "PATCH",
        "header": [
          {
            "description": "Added as a part of security scheme: oauth2",
            "key": "Authorization",
            "value": "<token>"
          }
        ],
        "body": {
          "mode": "formdata",
          "formdata": [
            {
              "key": "id",
              "value": "dolore est",
              "description": "Role Id.",
              "type": "text"
            },
            {
              "key": "name",
              "value": "enim esse",
              "description": "Name of the role.",
              "type": "text"
            },
            {
              "key": "description",
              "value": "elit veniam",
              "description": "Description of the role.",
              "type": "text"
            },
            {
              "key": "total_members",
              "value": "-91821999",
              "description": "Total members assigned to that role.",
              "type": "text"
            },
            {
              "key": "privileges",
              "value": "[\"fugiat officia dolore laboris Ut\",\"adipisicing\"]",
              "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).\n",
              "type": "text"
            },
            {
              "key": "sub_account_privileges",
              "value": "{\"second_level\":96157102}",
              "description": "This field will only be displayed to accounts that are enrolled in the partner plan and follow master accounts and sub accounts structure.",
              "type": "text"
            }
          ]
        },
        "url": {
          "raw": "{{baseUrl}}/roles/:roleId",
          "host": [
            "{{baseUrl}}"
          ],
          "path": [
            "roles",
            ":roleId"
          ],
          "variable": [
            {
              "key": "roleId",
              "value": "quis officia in reprehenderit",
              "description": "(Required) Role Id"
            }
          ]
        }
      },
      "status": "No Content",
      "code": 204,
      "_postman_previewlanguage": "text",
      "header": [
        {
          "key": "Content-Type",
          "value": "text/plain"
        }
      ],
      "cookie": [
      ],
      "body": ""
    },
    {
      "name": "**Error Code:** `300`\nThis role cannot be updated.",
      "originalRequest": {
        "method": "PATCH",
        "header": [
          {
            "description": "Added as a part of security scheme: oauth2",
            "key": "Authorization",
            "value": "<token>"
          }
        ],
        "body": {
          "mode": "formdata",
          "formdata": [
            {
              "key": "id",
              "value": "dolore est",
              "description": "Role Id.",
              "type": "text"
            },
            {
              "key": "name",
              "value": "enim esse",
              "description": "Name of the role.",
              "type": "text"
            },
            {
              "key": "description",
              "value": "elit veniam",
              "description": "Description of the role.",
              "type": "text"
            },
            {
              "key": "total_members",
              "value": "-91821999",
              "description": "Total members assigned to that role.",
              "type": "text"
            },
            {
              "key": "privileges",
              "value": "[\"fugiat officia dolore laboris Ut\",\"adipisicing\"]",
              "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).\n",
              "type": "text"
            },
            {
              "key": "sub_account_privileges",
              "value": "{\"second_level\":96157102}",
              "description": "This field will only be displayed to accounts that are enrolled in the partner plan and follow master accounts and sub accounts structure.",
              "type": "text"
            }
          ]
        },
        "url": {
          "raw": "{{baseUrl}}/roles/:roleId",
          "host": [
            "{{baseUrl}}"
          ],
          "path": [
            "roles",
            ":roleId"
          ],
          "variable": [
            {
              "key": "roleId",
              "value": "quis officia in reprehenderit",
              "description": "(Required) Role Id"
            }
          ]
        }
      },
      "status": "Multiple Choices",
      "code": 300,
      "_postman_previewlanguage": "text",
      "header": [
        {
          "key": "Content-Type",
          "value": "text/plain"
        }
      ],
      "cookie": [
      ],
      "body": ""
    }
  ]
}