Chilkat Online Tools

PureBasic / Zoom API / Add group admins

Back to Collection Items

IncludeFile "CkJsonArray.pb"
IncludeFile "CkHttpResponse.pb"
IncludeFile "CkHttp.pb"
IncludeFile "CkJsonObject.pb"
IncludeFile "CkHttpRequest.pb"

Procedure ChilkatExample()

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

    http.i = CkHttp::ckCreate()
    If http.i = 0
        Debug "Failed to create object."
        ProcedureReturn
    EndIf

    success.i

    req.i = CkHttpRequest::ckCreate()
    If req.i = 0
        Debug "Failed to create object."
        ProcedureReturn
    EndIf

    CkHttpRequest::setCkHttpVerb(req, "POST")
    CkHttpRequest::setCkPath(req, "/v2/groups/:groupId/admins")
    CkHttpRequest::setCkContentType(req, "multipart/form-data")

    jsonFormData1.i = CkJsonArray::ckCreate()
    If jsonFormData1.i = 0
        Debug "Failed to create object."
        ProcedureReturn
    EndIf

    CkJsonArray::ckAddObjectAt(jsonFormData1,-1)
    jsonObj_1.i = CkJsonArray::ckObjectAt(jsonFormData1,CkJsonArray::ckSize(jsonFormData1) - 1)
    CkJsonObject::ckUpdateString(jsonObj_1,"id","Ut veniam nostrud nisi")
    CkJsonObject::ckUpdateString(jsonObj_1,"email","nostrud exercitation")
    CkJsonObject::ckDispose(jsonObj_1)

    CkJsonArray::ckAddObjectAt(jsonFormData1,-1)
    jsonObj_1 = CkJsonArray::ckObjectAt(jsonFormData1,CkJsonArray::ckSize(jsonFormData1) - 1)
    CkJsonObject::ckUpdateString(jsonObj_1,"id","aliquip cillum")
    CkJsonObject::ckUpdateString(jsonObj_1,"email","amet labore dolor in consectetur")
    CkJsonObject::ckDispose(jsonObj_1)

    CkHttpRequest::ckAddParam(req,"admins",CkJsonArray::ckEmit(jsonFormData1))

    CkHttpRequest::ckAddHeader(req,"Authorization","Bearer <access_token>")

    resp.i = CkHttp::ckSynchronousRequest(http,"api.zoom.us",443,1,req)
    If CkHttp::ckLastMethodSuccess(http) = 0
        Debug CkHttp::ckLastErrorText(http)
        CkHttp::ckDispose(http)
        CkHttpRequest::ckDispose(req)
        CkJsonArray::ckDispose(jsonFormData1)
        ProcedureReturn
    EndIf

    Debug Str(CkHttpResponse::ckStatusCode(resp))
    Debug CkHttpResponse::ckBodyStr(resp)
    CkHttpResponse::ckDispose(resp)



    CkHttp::ckDispose(http)
    CkHttpRequest::ckDispose(req)
    CkJsonArray::ckDispose(jsonFormData1)


    ProcedureReturn
EndProcedure

Curl Command

curl -X POST
	-H "Authorization: Bearer <access_token>"
	-H "Content-Type: multipart/form-data"
	--form 'admins=[{"id":"Ut veniam nostrud nisi","email":"nostrud exercitation"},{"id":"aliquip cillum","email":"amet labore dolor in consectetur"}]'
https://api.zoom.us/v2/groups/:groupId/admins

Postman Collection Item JSON

{
  "name": "Add group admins",
  "request": {
    "method": "POST",
    "header": [
      {
        "key": "Content-Type",
        "value": "multipart/form-data"
      }
    ],
    "body": {
      "mode": "formdata",
      "formdata": [
        {
          "key": "admins",
          "value": "[{\"id\":\"Ut veniam nostrud nisi\",\"email\":\"nostrud exercitation\"},{\"id\":\"aliquip cillum\",\"email\":\"amet labore dolor in consectetur\"}]",
          "description": "A list of the administrators to add to a group.",
          "type": "text"
        }
      ]
    },
    "url": {
      "raw": "{{baseUrl}}/groups/:groupId/admins",
      "host": [
        "{{baseUrl}}"
      ],
      "path": [
        "groups",
        ":groupId",
        "admins"
      ],
      "variable": [
        {
          "key": "groupId",
          "value": "quis officia in reprehenderit",
          "description": "(Required) The group ID.<br>\nCan be retrieved by calling [GET /groups](https://marketplace.zoom.us/docs/api-reference/zoom-api/groups/groups)."
        }
      ]
    },
    "description": "Use this API to add administrators to a [group](https://support.zoom.us/hc/en-us/articles/204519819-Group-Management-) under your account.\n\n**Scopes:** `group:write:admin`<br>**[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `Medium`\n\n**Prerequisites:** \n* A Pro, Business, or Education account"
  },
  "response": [
    {
      "name": "**Status Code:** `200` <br> Only available for paid account: \"{accountId}\".",
      "originalRequest": {
        "method": "POST",
        "header": [
          {
            "description": "Added as a part of security scheme: oauth2",
            "key": "Authorization",
            "value": "<token>"
          }
        ],
        "body": {
          "mode": "formdata",
          "formdata": [
            {
              "key": "admins",
              "value": "[{\"id\":\"enim amet aliqua\",\"email\":\"mollit aliqua consectetur\"},{\"id\":\"proident officia anim\",\"email\":\"ullamco do\"}]",
              "description": "A list of the administrators to add to a group.",
              "type": "text"
            }
          ]
        },
        "url": {
          "raw": "{{baseUrl}}/groups/:groupId/admins",
          "host": [
            "{{baseUrl}}"
          ],
          "path": [
            "groups",
            ":groupId",
            "admins"
          ],
          "variable": [
            {
              "key": "groupId",
              "value": "quis officia in reprehenderit",
              "description": "(Required) The group ID.<br>\nCan be retrieved by calling [GET /groups](https://marketplace.zoom.us/docs/api-reference/zoom-api/groups/groups)."
            }
          ]
        }
      },
      "status": "OK",
      "code": 200,
      "_postman_previewlanguage": "text",
      "header": [
        {
          "key": "Content-Type",
          "value": "text/plain"
        }
      ],
      "cookie": [
      ],
      "body": ""
    },
    {
      "name": "**Status Code:** `201` <br> Group administrator added.",
      "originalRequest": {
        "method": "POST",
        "header": [
          {
            "description": "Added as a part of security scheme: oauth2",
            "key": "Authorization",
            "value": "<token>"
          }
        ],
        "body": {
          "mode": "formdata",
          "formdata": [
            {
              "key": "admins",
              "value": "[{\"id\":\"enim amet aliqua\",\"email\":\"mollit aliqua consectetur\"},{\"id\":\"proident officia anim\",\"email\":\"ullamco do\"}]",
              "description": "A list of the administrators to add to a group.",
              "type": "text"
            }
          ]
        },
        "url": {
          "raw": "{{baseUrl}}/groups/:groupId/admins",
          "host": [
            "{{baseUrl}}"
          ],
          "path": [
            "groups",
            ":groupId",
            "admins"
          ],
          "variable": [
            {
              "key": "groupId",
              "value": "quis officia in reprehenderit",
              "description": "(Required) The group ID.<br>\nCan be retrieved by calling [GET /groups](https://marketplace.zoom.us/docs/api-reference/zoom-api/groups/groups)."
            }
          ]
        }
      },
      "status": "Created",
      "code": 201,
      "_postman_previewlanguage": "json",
      "header": [
        {
          "key": "Content-Type",
          "value": "application/json"
        }
      ],
      "cookie": [
      ],
      "body": "{\n \"ids\": [\n  \"abc4545fdgfdhg\",\n  \"lgfdkhg123456\"\n ],\n \"added_at\": \"2019-09-27T00:14:46Z\"\n}"
    },
    {
      "name": "**Status Code:** `404` <br> Not found. <br> **Error Code:** `4130` <br> A group with the \"{groupId}\" ID does not exist.",
      "originalRequest": {
        "method": "POST",
        "header": [
          {
            "description": "Added as a part of security scheme: oauth2",
            "key": "Authorization",
            "value": "<token>"
          }
        ],
        "body": {
          "mode": "formdata",
          "formdata": [
            {
              "key": "admins",
              "value": "[{\"id\":\"enim amet aliqua\",\"email\":\"mollit aliqua consectetur\"},{\"id\":\"proident officia anim\",\"email\":\"ullamco do\"}]",
              "description": "A list of the administrators to add to a group.",
              "type": "text"
            }
          ]
        },
        "url": {
          "raw": "{{baseUrl}}/groups/:groupId/admins",
          "host": [
            "{{baseUrl}}"
          ],
          "path": [
            "groups",
            ":groupId",
            "admins"
          ],
          "variable": [
            {
              "key": "groupId",
              "value": "quis officia in reprehenderit",
              "description": "(Required) The group ID.<br>\nCan be retrieved by calling [GET /groups](https://marketplace.zoom.us/docs/api-reference/zoom-api/groups/groups)."
            }
          ]
        }
      },
      "status": "Not Found",
      "code": 404,
      "_postman_previewlanguage": "text",
      "header": [
        {
          "key": "Content-Type",
          "value": "text/plain"
        }
      ],
      "cookie": [
      ],
      "body": ""
    }
  ]
}