DataFlex / Zoom API / Create an IM directory group
Back to Collection Items
Use ChilkatAx-win32.pkg
Procedure Test
Handle hoHttp
Boolean iSuccess
Variant vReq
Handle hoReq
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"
Set ComContentType Of hoReq To "multipart/form-data"
Send ComAddParam To hoReq "Excepteur proident in" ""
Get ComAddStringForUpload2 Of hoReq "" "" "" "" "Excepteur proident innormal" To iSuccess
Send ComAddParam To hoReq "search_by_domain" "Excepteur proident innormalfalse"
Send ComAddParam To hoReq "search_by_account" "Excepteur proident innormalfalsetrue"
Send ComAddParam To hoReq "search_by_ma_account" "Excepteur proident innormalfalsetruefalse"
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 'name=Excepteur proident in'
--form 'type=Excepteur proident innormal'
--form 'search_by_domain=Excepteur proident innormalfalse'
--form 'search_by_account=Excepteur proident innormalfalsetrue'
--form 'search_by_ma_account=Excepteur proident innormalfalsetruefalse'
https://api.zoom.us/v2/im/groups
Postman Collection Item JSON
{
"name": "Create an IM directory group",
"request": {
"method": "POST",
"header": [
{
"key": "Content-Type",
"value": "multipart/form-data"
}
],
"body": {
"mode": "formdata",
"formdata": [
{
"key": "name",
"value": "Excepteur proident in",
"description": "Group name: must be unique to one account.",
"type": "text"
},
{
"key": "type",
"value": "normal",
"description": "IM Group types:<br>`normal` - Only members can see automatically see the other members of this group. Other people can search for members within this group. <br>`shared` - Everyone under an account can see the group members automatically.<br>`restricted` - Nobody can see the group or search for members except the members in the group. (This can only be one of normal,shared,restricted)",
"type": "text"
},
{
"key": "search_by_domain",
"value": "false",
"description": "Members can search for others in the same email domain.",
"type": "text"
},
{
"key": "search_by_account",
"value": "true",
"description": "Members can search for others under same account.",
"type": "text"
},
{
"key": "search_by_ma_account",
"value": "false",
"description": "Members can search for others under same master account, including all sub accounts.",
"type": "text"
}
]
},
"url": {
"raw": "{{baseUrl}}/im/groups",
"host": [
"{{baseUrl}}"
],
"path": [
"im",
"groups"
]
},
"description": "Create an [IM directory group](https://support.zoom.us/hc/en-us/articles/203749815-IM-Management) under your account.<br><br>\n**Scopes**: `imgroup: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>\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": "name",
"value": "Excepteur proident in",
"description": "Group name: must be unique to one account.",
"type": "text"
},
{
"key": "type",
"value": "normal",
"description": "IM Group types:<br>`normal` - Only members can see automatically see the other members of this group. Other people can search for members within this group. <br>`shared` - Everyone under an account can see the group members automatically.<br>`restricted` - Nobody can see the group or search for members except the members in the group. (This can only be one of normal,shared,restricted)",
"type": "text"
},
{
"key": "search_by_domain",
"value": "false",
"description": "Members can search for others in the same email domain.",
"type": "text"
},
{
"key": "search_by_account",
"value": "true",
"description": "Members can search for others under same account.",
"type": "text"
},
{
"key": "search_by_ma_account",
"value": "false",
"description": "Members can search for others under same master account, including all sub accounts.",
"type": "text"
}
]
},
"url": {
"raw": "{{baseUrl}}/im/groups",
"host": [
"{{baseUrl}}"
],
"path": [
"im",
"groups"
]
}
},
"status": "OK",
"code": 200,
"_postman_previewlanguage": "text",
"header": [
{
"key": "Content-Type",
"value": "text/plain"
}
],
"cookie": [
],
"body": ""
},
{
"name": "**HTTP Status Code:** `201`<br>\nIM Group 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": "Excepteur proident in",
"description": "Group name: must be unique to one account.",
"type": "text"
},
{
"key": "type",
"value": "normal",
"description": "IM Group types:<br>`normal` - Only members can see automatically see the other members of this group. Other people can search for members within this group. <br>`shared` - Everyone under an account can see the group members automatically.<br>`restricted` - Nobody can see the group or search for members except the members in the group. (This can only be one of normal,shared,restricted)",
"type": "text"
},
{
"key": "search_by_domain",
"value": "false",
"description": "Members can search for others in the same email domain.",
"type": "text"
},
{
"key": "search_by_account",
"value": "true",
"description": "Members can search for others under same account.",
"type": "text"
},
{
"key": "search_by_ma_account",
"value": "false",
"description": "Members can search for others under same master account, including all sub accounts.",
"type": "text"
}
]
},
"url": {
"raw": "{{baseUrl}}/im/groups",
"host": [
"{{baseUrl}}"
],
"path": [
"im",
"groups"
]
}
},
"status": "Created",
"code": 201,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Location",
"value": "quis officia in reprehenderit",
"description": "Location of created IM Group"
},
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [
],
"body": "{}"
},
{
"name": "**HTTP Status Code:** `404` <br>\n**Error Code:** `4130` <br>\nGroup does not exist:{groupId}.",
"originalRequest": {
"method": "POST",
"header": [
{
"description": "Added as a part of security scheme: oauth2",
"key": "Authorization",
"value": "<token>"
}
],
"body": {
"mode": "formdata",
"formdata": [
{
"key": "name",
"value": "Excepteur proident in",
"description": "Group name: must be unique to one account.",
"type": "text"
},
{
"key": "type",
"value": "normal",
"description": "IM Group types:<br>`normal` - Only members can see automatically see the other members of this group. Other people can search for members within this group. <br>`shared` - Everyone under an account can see the group members automatically.<br>`restricted` - Nobody can see the group or search for members except the members in the group. (This can only be one of normal,shared,restricted)",
"type": "text"
},
{
"key": "search_by_domain",
"value": "false",
"description": "Members can search for others in the same email domain.",
"type": "text"
},
{
"key": "search_by_account",
"value": "true",
"description": "Members can search for others under same account.",
"type": "text"
},
{
"key": "search_by_ma_account",
"value": "false",
"description": "Members can search for others under same master account, including all sub accounts.",
"type": "text"
}
]
},
"url": {
"raw": "{{baseUrl}}/im/groups",
"host": [
"{{baseUrl}}"
],
"path": [
"im",
"groups"
]
}
},
"status": "Not Found",
"code": 404,
"_postman_previewlanguage": "text",
"header": [
{
"key": "Content-Type",
"value": "text/plain"
}
],
"cookie": [
],
"body": ""
},
{
"name": "**HTTP Status Code:** `409` <br>\n**Error Code:** `4132` <br>\nGroup name {groupName} is already in use.",
"originalRequest": {
"method": "POST",
"header": [
{
"description": "Added as a part of security scheme: oauth2",
"key": "Authorization",
"value": "<token>"
}
],
"body": {
"mode": "formdata",
"formdata": [
{
"key": "name",
"value": "Excepteur proident in",
"description": "Group name: must be unique to one account.",
"type": "text"
},
{
"key": "type",
"value": "normal",
"description": "IM Group types:<br>`normal` - Only members can see automatically see the other members of this group. Other people can search for members within this group. <br>`shared` - Everyone under an account can see the group members automatically.<br>`restricted` - Nobody can see the group or search for members except the members in the group. (This can only be one of normal,shared,restricted)",
"type": "text"
},
{
"key": "search_by_domain",
"value": "false",
"description": "Members can search for others in the same email domain.",
"type": "text"
},
{
"key": "search_by_account",
"value": "true",
"description": "Members can search for others under same account.",
"type": "text"
},
{
"key": "search_by_ma_account",
"value": "false",
"description": "Members can search for others under same master account, including all sub accounts.",
"type": "text"
}
]
},
"url": {
"raw": "{{baseUrl}}/im/groups",
"host": [
"{{baseUrl}}"
],
"path": [
"im",
"groups"
]
}
},
"status": "Conflict",
"code": 409,
"_postman_previewlanguage": "text",
"header": [
{
"key": "Content-Type",
"value": "text/plain"
}
],
"cookie": [
],
"body": ""
}
]
}
