unicodeC / Zoom API / Update a group member
Back to Collection Items
#include <C_CkHttpW.h>
#include <C_CkHttpRequestW.h>
#include <C_CkHttpResponseW.h>
#include <C_CkStringBuilderW.h>
#include <C_CkJsonObjectW.h>
void ChilkatSample(void)
{
HCkHttpW http;
BOOL success;
HCkHttpRequestW req;
HCkHttpResponseW resp;
HCkStringBuilderW sbResponseBody;
HCkJsonObjectW jResp;
int respStatusCode;
// This example assumes the Chilkat API to have been previously unlocked.
// See Global Unlock Sample for sample code.
http = CkHttpW_Create();
req = CkHttpRequestW_Create();
CkHttpRequestW_putHttpVerb(req,L"PATCH");
CkHttpRequestW_putPath(req,L"/v2/groups/:groupId/members/:memberId");
CkHttpRequestW_putContentType(req,L"multipart/form-data");
CkHttpRequestW_AddParam(req,L"action",L"move");
CkHttpRequestW_AddParam(req,L"target_group_id",L"movevelit pariatur dolor");
CkHttpRequestW_AddHeader(req,L"Authorization",L"Bearer <access_token>");
resp = CkHttpW_SynchronousRequest(http,L"api.zoom.us",443,TRUE,req);
if (CkHttpW_getLastMethodSuccess(http) == FALSE) {
wprintf(L"%s\n",CkHttpW_lastErrorText(http));
CkHttpW_Dispose(http);
CkHttpRequestW_Dispose(req);
return;
}
sbResponseBody = CkStringBuilderW_Create();
CkHttpResponseW_GetBodySb(resp,sbResponseBody);
jResp = CkJsonObjectW_Create();
CkJsonObjectW_LoadSb(jResp,sbResponseBody);
CkJsonObjectW_putEmitCompact(jResp,FALSE);
wprintf(L"Response Body:\n");
wprintf(L"%s\n",CkJsonObjectW_emit(jResp));
respStatusCode = CkHttpResponseW_getStatusCode(resp);
wprintf(L"Response Status Code = %d\n",respStatusCode);
if (respStatusCode >= 400) {
wprintf(L"Response Header:\n");
wprintf(L"%s\n",CkHttpResponseW_header(resp));
wprintf(L"Failed.\n");
CkHttpResponseW_Dispose(resp);
CkHttpW_Dispose(http);
CkHttpRequestW_Dispose(req);
CkStringBuilderW_Dispose(sbResponseBody);
CkJsonObjectW_Dispose(jResp);
return;
}
CkHttpResponseW_Dispose(resp);
CkHttpW_Dispose(http);
CkHttpRequestW_Dispose(req);
CkStringBuilderW_Dispose(sbResponseBody);
CkJsonObjectW_Dispose(jResp);
}
Curl Command
curl -X PATCH
-H "Authorization: Bearer <access_token>"
-H "Content-Type: multipart/form-data"
--form 'action=move'
--form 'target_group_id=movevelit pariatur dolor'
https://api.zoom.us/v2/groups/:groupId/members/:memberId
Postman Collection Item JSON
{
"name": "Update a group member",
"request": {
"auth": {
"type": "oauth2"
},
"method": "PATCH",
"header": [
{
"key": "Content-Type",
"value": "multipart/form-data"
}
],
"body": {
"mode": "formdata",
"formdata": [
{
"key": "action",
"value": "move",
"description": "(Required) The action to perform: \n* `move` — Remove the group member from one group and move them to a different group. \n* `set_primary` — Set the user's primary group. (This can only be one of move,set_primary)",
"type": "text"
},
{
"key": "target_group_id",
"value": "velit pariatur dolor",
"description": "The target group's ID. To get this value, use the [List Groups](https://marketplace.zoom.us/docs/api-reference/zoom-api/groups/groups) API. \n* To set a user's primary group, use the designated primary group's `groupId` value. \n* To move a group member from one group to another, use the `groupId` of the designated group.",
"type": "text"
}
]
},
"url": {
"raw": "{{baseUrl}}/groups/:groupId/members/:memberId",
"host": [
"{{baseUrl}}"
],
"path": [
"groups",
":groupId",
"members",
":memberId"
],
"variable": [
{
"key": "groupId",
"value": "quis officia in reprehenderit",
"description": "(Required) The group's unique ID. To get this value, use the [List Groups](https://marketplace.zoom.us/docs/api-reference/zoom-api/groups/groups) API.\n* To set a user's primary group, use the `target_group_id` value for this parameter's value. \n* To move a group member from one group to another, use the `groupId` of the designated group."
},
{
"key": "memberId",
"value": "quis officia in reprehenderit",
"description": "(Required) The group member's unique ID. To get this value, use the [List Group Members](https://marketplace.zoom.us/docs/api-reference/zoom-api/groups/groupmembers) API."
}
]
},
"description": "Use this API to perform either of the following tasks: \n* Remove a group member from one group and move them to a different group. \n* Set a user's primary group. By default, the primary group is the first group that user is added to.\n\nIf a user is a member of multiple groups, you can [assign the user a primary group](https://support.zoom.us/hc/en-us/articles/204519819-Group-Management-#h_d07c7dcd-4fd8-485a-b5fe-a322e8d21c09). The user will use the primary group’s settings by default. However, if the user is a member of a group with locked settings, those group settings will remain locked to the user.\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 or higher account"
},
"response": [
{
"name": "**HTTP Status Code:** `204` **No Content**<br>\nGroup member updated.",
"originalRequest": {
"method": "PATCH",
"header": [
{
"description": "Added as a part of security scheme: oauth2",
"key": "Authorization",
"value": "<token>"
}
],
"body": {
"mode": "formdata",
"formdata": [
{
"key": "action",
"value": "move",
"description": "(Required) The action to perform: \n* `move` — Remove the group member from one group and move them to a different group. \n* `set_primary` — Set the user's primary group. (This can only be one of move,set_primary)",
"type": "text"
},
{
"key": "target_group_id",
"value": "velit pariatur dolor",
"description": "The target group's ID. To get this value, use the [List Groups](https://marketplace.zoom.us/docs/api-reference/zoom-api/groups/groups) API. \n* To set a user's primary group, use the designated primary group's `groupId` value. \n* To move a group member from one group to another, use the `groupId` of the designated group.",
"type": "text"
}
]
},
"url": {
"raw": "{{baseUrl}}/groups/:groupId/members/:memberId",
"host": [
"{{baseUrl}}"
],
"path": [
"groups",
":groupId",
"members",
":memberId"
],
"variable": [
{
"key": "groupId",
"value": "quis officia in reprehenderit",
"description": "(Required) The group's unique ID. To get this value, use the [List Groups](https://marketplace.zoom.us/docs/api-reference/zoom-api/groups/groups) API.\n* To set a user's primary group, use the `target_group_id` value for this parameter's value. \n* To move a group member from one group to another, use the `groupId` of the designated group."
},
{
"key": "memberId",
"value": "quis officia in reprehenderit",
"description": "(Required) The group member's unique ID. To get this value, use the [List Group Members](https://marketplace.zoom.us/docs/api-reference/zoom-api/groups/groupmembers) API."
}
]
}
},
"status": "No Content",
"code": 204,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [
],
"body": "{}"
},
{
"name": "**HTTP Status Code:** `400` **Bad Request**<br>\n**Error Code:** `200`<br>\n Only available for Paid account, {accountId}.<br><br>\n **Error Code:** `300`<br>\n The target_group_id can not be empty.<br><br>\n **Error Code:** `1010`<br>\n Group does not belong t",
"originalRequest": {
"method": "PATCH",
"header": [
{
"description": "Added as a part of security scheme: oauth2",
"key": "Authorization",
"value": "<token>"
}
],
"body": {
"mode": "formdata",
"formdata": [
{
"key": "action",
"value": "move",
"description": "(Required) The action to perform: \n* `move` — Remove the group member from one group and move them to a different group. \n* `set_primary` — Set the user's primary group. (This can only be one of move,set_primary)",
"type": "text"
},
{
"key": "target_group_id",
"value": "velit pariatur dolor",
"description": "The target group's ID. To get this value, use the [List Groups](https://marketplace.zoom.us/docs/api-reference/zoom-api/groups/groups) API. \n* To set a user's primary group, use the designated primary group's `groupId` value. \n* To move a group member from one group to another, use the `groupId` of the designated group.",
"type": "text"
}
]
},
"url": {
"raw": "{{baseUrl}}/groups/:groupId/members/:memberId",
"host": [
"{{baseUrl}}"
],
"path": [
"groups",
":groupId",
"members",
":memberId"
],
"variable": [
{
"key": "groupId",
"value": "quis officia in reprehenderit",
"description": "(Required) The group's unique ID. To get this value, use the [List Groups](https://marketplace.zoom.us/docs/api-reference/zoom-api/groups/groups) API.\n* To set a user's primary group, use the `target_group_id` value for this parameter's value. \n* To move a group member from one group to another, use the `groupId` of the designated group."
},
{
"key": "memberId",
"value": "quis officia in reprehenderit",
"description": "(Required) The group member's unique ID. To get this value, use the [List Group Members](https://marketplace.zoom.us/docs/api-reference/zoom-api/groups/groupmembers) API."
}
]
}
},
"status": "Bad Request",
"code": 400,
"_postman_previewlanguage": "text",
"header": [
{
"key": "Content-Type",
"value": "text/plain"
}
],
"cookie": [
],
"body": ""
},
{
"name": "**HTTP Status Code:** `404` **Not Found**<br>\n**Error Code:** `4130`<br>\nA group with this {groupId} does not exist.",
"originalRequest": {
"method": "PATCH",
"header": [
{
"description": "Added as a part of security scheme: oauth2",
"key": "Authorization",
"value": "<token>"
}
],
"body": {
"mode": "formdata",
"formdata": [
{
"key": "action",
"value": "move",
"description": "(Required) The action to perform: \n* `move` — Remove the group member from one group and move them to a different group. \n* `set_primary` — Set the user's primary group. (This can only be one of move,set_primary)",
"type": "text"
},
{
"key": "target_group_id",
"value": "velit pariatur dolor",
"description": "The target group's ID. To get this value, use the [List Groups](https://marketplace.zoom.us/docs/api-reference/zoom-api/groups/groups) API. \n* To set a user's primary group, use the designated primary group's `groupId` value. \n* To move a group member from one group to another, use the `groupId` of the designated group.",
"type": "text"
}
]
},
"url": {
"raw": "{{baseUrl}}/groups/:groupId/members/:memberId",
"host": [
"{{baseUrl}}"
],
"path": [
"groups",
":groupId",
"members",
":memberId"
],
"variable": [
{
"key": "groupId",
"value": "quis officia in reprehenderit",
"description": "(Required) The group's unique ID. To get this value, use the [List Groups](https://marketplace.zoom.us/docs/api-reference/zoom-api/groups/groups) API.\n* To set a user's primary group, use the `target_group_id` value for this parameter's value. \n* To move a group member from one group to another, use the `groupId` of the designated group."
},
{
"key": "memberId",
"value": "quis officia in reprehenderit",
"description": "(Required) The group member's unique ID. To get this value, use the [List Group Members](https://marketplace.zoom.us/docs/api-reference/zoom-api/groups/groupmembers) API."
}
]
}
},
"status": "Not Found",
"code": 404,
"_postman_previewlanguage": "text",
"header": [
{
"key": "Content-Type",
"value": "text/plain"
}
],
"cookie": [
],
"body": ""
}
]
}