Chilkat Online Tools

Ruby / Zoom API / Add group members

Back to Collection Items

require 'chilkat'

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

http = Chilkat::CkHttp.new()

req = Chilkat::CkHttpRequest.new()
req.put_HttpVerb("POST")
req.put_Path("/v2/groups/:groupId/members")
req.put_ContentType("multipart/form-data")

jsonFormData1 = Chilkat::CkJsonArray.new()

jsonFormData1.AddObjectAt(-1)
# jsonObj_1 is a CkJsonObject
jsonObj_1 = jsonFormData1.ObjectAt(jsonFormData1.get_Size() - 1)
jsonObj_1.UpdateString("id","Ut")
jsonObj_1.UpdateString("email","Ut")

jsonFormData1.AddObjectAt(-1)
# jsonObj_1 is a CkJsonObject
jsonObj_1 = jsonFormData1.ObjectAt(jsonFormData1.get_Size() - 1)
jsonObj_1.UpdateString("id","incididunt tempor Duis laboris aliqua")
jsonObj_1.UpdateString("email","amet adipisicing minim pariatur")

req.AddStringForUpload2("members","",jsonFormData1,"utf-8","application/json")

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

# resp is a CkHttpResponse
resp = http.SynchronousRequest("api.zoom.us",443,true,req)
if (http.get_LastMethodSuccess() == false)
    print http.lastErrorText() + "\n";
    exit
end

print resp.get_StatusCode().to_s() + "\n";
print resp.bodyStr() + "\n";

Curl Command

curl -X POST
	-H "Authorization: Bearer <access_token>"
	-H "Content-Type: multipart/form-data"
	--form 'members=[{"id":"Ut","email":"Ut"},{"id":"incididunt tempor Duis laboris aliqua","email":"amet adipisicing minim pariatur"}]'
https://api.zoom.us/v2/groups/:groupId/members

Postman Collection Item JSON

{
  "name": "Add group members",
  "request": {
    "method": "POST",
    "header": [
      {
        "key": "Content-Type",
        "value": "multipart/form-data"
      }
    ],
    "body": {
      "mode": "formdata",
      "formdata": [
        {
          "key": "members",
          "value": "[{\"id\":\"Ut\",\"email\":\"Ut\"},{\"id\":\"incididunt tempor Duis laboris aliqua\",\"email\":\"amet adipisicing minim pariatur\"}]",
          "description": "List of Group members",
          "type": "text"
        }
      ]
    },
    "url": {
      "raw": "{{baseUrl}}/groups/:groupId/members",
      "host": [
        "{{baseUrl}}"
      ],
      "path": [
        "groups",
        ":groupId",
        "members"
      ],
      "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 users to a [group](https://support.zoom.us/hc/en-us/articles/204519819-Group-Management-) in 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": "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": "members",
              "value": "[{\"id\":\"elit aliquip aliqua ad\",\"email\":\"in ipsum dolor exercitation\"},{\"id\":\"irure aliqua Excepteur deserunt\",\"email\":\"culpa\"}]",
              "description": "List of Group members",
              "type": "text"
            }
          ]
        },
        "url": {
          "raw": "{{baseUrl}}/groups/:groupId/members",
          "host": [
            "{{baseUrl}}"
          ],
          "path": [
            "groups",
            ":groupId",
            "members"
          ],
          "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": "Member added.",
      "originalRequest": {
        "method": "POST",
        "header": [
          {
            "description": "Added as a part of security scheme: oauth2",
            "key": "Authorization",
            "value": "<token>"
          }
        ],
        "body": {
          "mode": "formdata",
          "formdata": [
            {
              "key": "members",
              "value": "[{\"id\":\"elit aliquip aliqua ad\",\"email\":\"in ipsum dolor exercitation\"},{\"id\":\"irure aliqua Excepteur deserunt\",\"email\":\"culpa\"}]",
              "description": "List of Group members",
              "type": "text"
            }
          ]
        },
        "url": {
          "raw": "{{baseUrl}}/groups/:groupId/members",
          "host": [
            "{{baseUrl}}"
          ],
          "path": [
            "groups",
            ":groupId",
            "members"
          ],
          "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\": \"string\",\n \"added_at\": \"string [date-time]\"\n}"
    },
    {
      "name": "**Status Code:** `404`<br>\nNot found.<br>\n**Error Code:** `4130`<br>\nA group with this {groupId} 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": "members",
              "value": "[{\"id\":\"elit aliquip aliqua ad\",\"email\":\"in ipsum dolor exercitation\"},{\"id\":\"irure aliqua Excepteur deserunt\",\"email\":\"culpa\"}]",
              "description": "List of Group members",
              "type": "text"
            }
          ]
        },
        "url": {
          "raw": "{{baseUrl}}/groups/:groupId/members",
          "host": [
            "{{baseUrl}}"
          ],
          "path": [
            "groups",
            ":groupId",
            "members"
          ],
          "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": ""
    }
  ]
}