lianja / Zoom API / Create a role
Back to Collection Items
// This example assumes the Chilkat API to have been previously unlocked.
// See Global Unlock Sample for sample code.
loHttp = createobject("CkHttp")
loReq = createobject("CkHttpRequest")
loReq.HttpVerb = "POST"
loReq.Path = "/v2/roles"
loReq.ContentType = "multipart/form-data"
loReq.AddParam("do ut","")
loReq.AddParam("description","do utin")
loReq.AddParam("privileges",'do utin["Ut consectetur id","fugiat in non"]')
loReq.AddHeader("Authorization","Bearer <access_token>")
loResp = loHttp.SynchronousRequest("api.zoom.us",443,.T.,loReq)
if (loHttp.LastMethodSuccess = .F.) then
? loHttp.LastErrorText
release loHttp
release loReq
return
endif
loSbResponseBody = createobject("CkStringBuilder")
loResp.GetBodySb(loSbResponseBody)
loJResp = createobject("CkJsonObject")
loJResp.LoadSb(loSbResponseBody)
loJResp.EmitCompact = .F.
? "Response Body:"
? loJResp.Emit()
lnRespStatusCode = loResp.StatusCode
? "Response Status Code = " + str(lnRespStatusCode)
if (lnRespStatusCode >= 400) then
? "Response Header:"
? loResp.Header
? "Failed."
release loResp
release loHttp
release loReq
release loSbResponseBody
release loJResp
return
endif
release loResp
release loHttp
release loReq
release loSbResponseBody
release loJResp
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": ""
}
]
}
