DataFlex / Zoom API / Add IM directory group members
Back to Collection Items
Use ChilkatAx-9.5.0-win32.pkg
Procedure Test
Handle hoHttp
Boolean iSuccess
Variant vReq
Handle hoReq
Handle hoJsonFormData1
Variant vJsonObj_1
Handle hoJsonObj_1
Variant vResp
Handle hoResp
String sTemp1
Integer iTemp1
Boolean bTemp1
// This example assumes the Chilkat API to have been previously unlocked.
// See Global Unlock Sample for sample code.
Get Create (RefClass(cComChilkatHttp)) To hoHttp
If (Not(IsComObjectCreated(hoHttp))) Begin
Send CreateComObject of hoHttp
End
Get Create (RefClass(cComChilkatHttpRequest)) To hoReq
If (Not(IsComObjectCreated(hoReq))) Begin
Send CreateComObject of hoReq
End
Set ComHttpVerb Of hoReq To "POST"
Set ComPath Of hoReq To "/v2/im/groups/:groupId/members"
Set ComContentType Of hoReq To "multipart/form-data"
Get Create (RefClass(cComChilkatJsonArray)) To hoJsonFormData1
If (Not(IsComObjectCreated(hoJsonFormData1))) Begin
Send CreateComObject of hoJsonFormData1
End
Get ComAddObjectAt Of hoJsonFormData1 -1 To iSuccess
Get ComSize Of hoJsonFormData1 To iTemp1
Get ComObjectAt Of hoJsonFormData1 (iTemp1 - 1) To vJsonObj_1
If (IsComObject(vJsonObj_1)) Begin
Get Create (RefClass(cComChilkatJsonObject)) To hoJsonObj_1
Set pvComObject Of hoJsonObj_1 To vJsonObj_1
End
Get ComUpdateString Of hoJsonObj_1 "id" "id do sunt" To iSuccess
Get ComUpdateString Of hoJsonObj_1 "email" "exercitation" To iSuccess
Send Destroy of hoJsonObj_1
Get ComAddObjectAt Of hoJsonFormData1 -1 To iSuccess
Get ComSize Of hoJsonFormData1 To iTemp1
Get ComObjectAt Of hoJsonFormData1 (iTemp1 - 1) To vJsonObj_1
If (IsComObject(vJsonObj_1)) Begin
Get Create (RefClass(cComChilkatJsonObject)) To hoJsonObj_1
Set pvComObject Of hoJsonObj_1 To vJsonObj_1
End
Get ComUpdateString Of hoJsonObj_1 "id" "sed aliqua sunt" To iSuccess
Get ComUpdateString Of hoJsonObj_1 "email" "quis" To iSuccess
Send Destroy of hoJsonObj_1
Get ComEmit Of hoJsonFormData1 To sTemp1
Send ComAddParam To hoReq "members" sTemp1
Send ComAddHeader To hoReq "Authorization" "Bearer <access_token>"
Get pvComObject of hoReq to vReq
Get ComSynchronousRequest Of hoHttp "api.zoom.us" 443 True vReq To vResp
If (IsComObject(vResp)) Begin
Get Create (RefClass(cComChilkatHttpResponse)) To hoResp
Set pvComObject Of hoResp To vResp
End
Get ComLastMethodSuccess Of hoHttp To bTemp1
If (bTemp1 = False) Begin
Get ComLastErrorText Of hoHttp To sTemp1
Showln sTemp1
Procedure_Return
End
Get ComStatusCode Of hoResp To iTemp1
Showln iTemp1
Get ComBodyStr Of hoResp To sTemp1
Showln sTemp1
Send Destroy of hoResp
End_Procedure
Curl Command
curl -X POST
-H "Authorization: Bearer <access_token>"
-H "Content-Type: multipart/form-data"
--form 'members=[{"id":"id do sunt","email":"exercitation"},{"id":"sed aliqua sunt","email":"quis"}]'
https://api.zoom.us/v2/im/groups/:groupId/members
Postman Collection Item JSON
{
"name": "Add IM directory group members",
"request": {
"auth": {
"type": "oauth2"
},
"method": "POST",
"header": [
{
"key": "Content-Type",
"value": "multipart/form-data"
}
],
"body": {
"mode": "formdata",
"formdata": [
{
"key": "members",
"value": "[{\"id\":\"id do sunt\",\"email\":\"exercitation\"},{\"id\":\"sed aliqua sunt\",\"email\":\"quis\"}]",
"description": "List of IM group members.",
"type": "text"
}
]
},
"url": {
"raw": "{{baseUrl}}/im/groups/:groupId/members",
"host": [
"{{baseUrl}}"
],
"path": [
"im",
"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": "Add members to an [IM directory group](https://support.zoom.us/hc/en-us/articles/203749815-IM-Management) under an account.<br><br>\n**Scope:** `imgroup:write:admin`<br>\n\n **[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `Medium`"
},
"response": [
{
"name": "**Error Code:** `200` <br>\nOnly 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\":\"dolor fugiat qui\",\"email\":\"ad elit adipisicing ipsum\"},{\"id\":\"labore\",\"email\":\"dolor ut ipsum\"}]",
"description": "List of IM group members.",
"type": "text"
}
]
},
"url": {
"raw": "{{baseUrl}}/im/groups/:groupId/members",
"host": [
"{{baseUrl}}"
],
"path": [
"im",
"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": "**HTTP Status Code:** `201` <br>\nMember 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\":\"dolor fugiat qui\",\"email\":\"ad elit adipisicing ipsum\"},{\"id\":\"labore\",\"email\":\"dolor ut ipsum\"}]",
"description": "List of IM group members.",
"type": "text"
}
]
},
"url": {
"raw": "{{baseUrl}}/im/groups/:groupId/members",
"host": [
"{{baseUrl}}"
],
"path": [
"im",
"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": "**Error Code:** `300` <br>\nMissing field: name.",
"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\":\"dolor fugiat qui\",\"email\":\"ad elit adipisicing ipsum\"},{\"id\":\"labore\",\"email\":\"dolor ut ipsum\"}]",
"description": "List of IM group members.",
"type": "text"
}
]
},
"url": {
"raw": "{{baseUrl}}/im/groups/:groupId/members",
"host": [
"{{baseUrl}}"
],
"path": [
"im",
"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": "Multiple Choices",
"code": 300,
"_postman_previewlanguage": "text",
"header": [
{
"key": "Content-Type",
"value": "text/plain"
}
],
"cookie": [
],
"body": ""
},
{
"name": "**HTTP Status Code:** `404` <br>\nIM Group not found",
"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\":\"dolor fugiat qui\",\"email\":\"ad elit adipisicing ipsum\"},{\"id\":\"labore\",\"email\":\"dolor ut ipsum\"}]",
"description": "List of IM group members.",
"type": "text"
}
]
},
"url": {
"raw": "{{baseUrl}}/im/groups/:groupId/members",
"host": [
"{{baseUrl}}"
],
"path": [
"im",
"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": ""
}
]
}
