SQL Server / Zoom API / Update a user
Back to Collection Items
-- Important: See this note about string length limitations for strings returned by sp_OAMethod calls.
--
CREATE PROCEDURE ChilkatSample
AS
BEGIN
DECLARE @hr int
DECLARE @iTmp0 int
-- Important: Do not use nvarchar(max). See the warning about using nvarchar(max).
DECLARE @sTmp0 nvarchar(4000)
-- This example assumes the Chilkat API to have been previously unlocked.
-- See Global Unlock Sample for sample code.
DECLARE @http int
-- Use "Chilkat_9_5_0.Http" for versions of Chilkat < 10.0.0
EXEC @hr = sp_OACreate 'Chilkat.Http', @http OUT
IF @hr <> 0
BEGIN
PRINT 'Failed to create ActiveX component'
RETURN
END
DECLARE @success int
DECLARE @req int
-- Use "Chilkat_9_5_0.HttpRequest" for versions of Chilkat < 10.0.0
EXEC @hr = sp_OACreate 'Chilkat.HttpRequest', @req OUT
EXEC sp_OASetProperty @req, 'HttpVerb', 'PATCH'
EXEC sp_OASetProperty @req, 'Path', '/v2/users/:userId?login_type=100&remove_tsp_credentials=true'
EXEC sp_OASetProperty @req, 'ContentType', 'multipart/form-data'
EXEC sp_OAMethod @req, 'AddParam', NULL, 'first_name', 'in nu'
EXEC sp_OAMethod @req, 'AddParam', NULL, 'last_name', 'in nuelit'
EXEC sp_OAMethod @req, 'AddStringForUpload2', @success OUT, '', '', '', '', 'in nuelit99'
EXEC sp_OAMethod @req, 'AddParam', NULL, 'pmi', 'in nuelit99-25518892'
EXEC sp_OAMethod @req, 'AddParam', NULL, 'use_pmi', 'in nuelit99-25518892false'
EXEC sp_OAMethod @req, 'AddParam', NULL, 'timezone', 'in nuelit99-25518892falseanim ipsum in'
EXEC sp_OAMethod @req, 'AddParam', NULL, 'language', 'in nuelit99-25518892falseanim ipsum indolor veniam cupidatat'
EXEC sp_OAMethod @req, 'AddParam', NULL, 'dept', 'in nuelit99-25518892falseanim ipsum indolor veniam cupidatatdolor tempor'
EXEC sp_OAMethod @req, 'AddParam', NULL, 'vanity_name', 'in nuelit99-25518892falseanim ipsum indolor veniam cupidatatdolor temporin quis dolor labore'
EXEC sp_OAMethod @req, 'AddParam', NULL, 'host_key', 'in nuelit99-25518892falseanim ipsum indolor veniam cupidatatdolor temporin quis dolor laboreenim p'
EXEC sp_OAMethod @req, 'AddParam', NULL, 'cms_user_id', 'in nuelit99-25518892falseanim ipsum indolor veniam cupidatatdolor temporin quis dolor laboreenim pnisi commodo Ut'
EXEC sp_OAMethod @req, 'AddParam', NULL, 'job_title', 'in nuelit99-25518892falseanim ipsum indolor veniam cupidatatdolor temporin quis dolor laboreenim pnisi commodo Utnisi elit fugiat'
EXEC sp_OAMethod @req, 'AddParam', NULL, 'company', 'in nuelit99-25518892falseanim ipsum indolor veniam cupidatatdolor temporin quis dolor laboreenim pnisi commodo Utnisi elit fugiatdolore mollit enim ex'
EXEC sp_OAMethod @req, 'AddParam', NULL, 'location', 'in nuelit99-25518892falseanim ipsum indolor veniam cupidatatdolor temporin quis dolor laboreenim pnisi commodo Utnisi elit fugiatdolore mollit enim exreprehenderit laboris esse dolore'
EXEC sp_OAMethod @req, 'AddParam', NULL, 'phone_number', 'in nuelit99-25518892falseanim ipsum indolor veniam cupidatatdolor temporin quis dolor laboreenim pnisi commodo Utnisi elit fugiatdolore mollit enim exreprehenderit laboris esse doloreproident incididunt'
EXEC sp_OAMethod @req, 'AddParam', NULL, 'phone_country', 'in nuelit99-25518892falseanim ipsum indolor veniam cupidatatdolor temporin quis dolor laboreenim pnisi commodo Utnisi elit fugiatdolore mollit enim exreprehenderit laboris esse doloreproident incididuntmollit labore et laborum'
EXEC sp_OAMethod @req, 'AddParam', NULL, 'custom_attributes', 'in nuelit99-25518892falseanim ipsum indolor veniam cupidatatdolor temporin quis dolor laboreenim pnisi commodo Utnisi elit fugiatdolore mollit enim exreprehenderit laboris esse doloreproident incididuntmollit labore et laborum{"key":"fugiat","name":"reprehenderit ullamco sit fugiat","value":"incididunt"}'
EXEC sp_OAMethod @req, 'AddParam', NULL, 'group_id', 'in nuelit99-25518892falseanim ipsum indolor veniam cupidatatdolor temporin quis dolor laboreenim pnisi commodo Utnisi elit fugiatdolore mollit enim exreprehenderit laboris esse doloreproident incididuntmollit labore et laborum{"key":"fugiat","name":"reprehenderit ullamco sit fugiat","value":"incididunt"}amet Lorem reprehenderit eu sed'
EXEC sp_OAMethod @req, 'AddParam', NULL, 'phone_numbers', 'in nuelit99-25518892falseanim ipsum indolor veniam cupidatatdolor temporin quis dolor laboreenim pnisi commodo Utnisi elit fugiatdolore mollit enim exreprehenderit laboris esse doloreproident incididuntmollit labore et laborum{"key":"fugiat","name":"reprehenderit ullamco sit fugiat","value":"incididunt"}amet Lorem reprehenderit eu sed{"country":"ut ullamco ea","code":"ad adipisicing","number":"eiusmod ipsum enim","label":"Home"}'
EXEC sp_OAMethod @req, 'AddParam', NULL, 'manager', 'in nuelit99-25518892falseanim ipsum indolor veniam cupidatatdolor temporin quis dolor laboreenim pnisi commodo Utnisi elit fugiatdolore mollit enim exreprehenderit laboris esse doloreproident incididuntmollit labore et laborum{"key":"fugiat","name":"reprehenderit ullamco sit fugiat","value":"incididunt"}amet Lorem reprehenderit eu sed{"country":"ut ullamco ea","code":"ad adipisicing","number":"eiusmod ipsum enim","label":"Home"}H-BwfF@h.qxj'
EXEC sp_OAMethod @req, 'AddParam', NULL, 'pronouns', 'in nuelit99-25518892falseanim ipsum indolor veniam cupidatatdolor temporin quis dolor laboreenim pnisi commodo Utnisi elit fugiatdolore mollit enim exreprehenderit laboris esse doloreproident incididuntmollit labore et laborum{"key":"fugiat","name":"reprehenderit ullamco sit fugiat","value":"incididunt"}amet Lorem reprehenderit eu sed{"country":"ut ullamco ea","code":"ad adipisicing","number":"eiusmod ipsum enim","label":"Home"}H-BwfF@h.qxjexercitation laboris'
EXEC sp_OAMethod @req, 'AddParam', NULL, 'pronouns_option', 'in nuelit99-25518892falseanim ipsum indolor veniam cupidatatdolor temporin quis dolor laboreenim pnisi commodo Utnisi elit fugiatdolore mollit enim exreprehenderit laboris esse doloreproident incididuntmollit labore et laborum{"key":"fugiat","name":"reprehenderit ullamco sit fugiat","value":"incididunt"}amet Lorem reprehenderit eu sed{"country":"ut ullamco ea","code":"ad adipisicing","number":"eiusmod ipsum enim","label":"Home"}H-BwfF@h.qxjexercitation laboris2'
EXEC sp_OAMethod @req, 'AddHeader', NULL, 'Authorization', 'Bearer <access_token>'
DECLARE @resp int
EXEC sp_OAMethod @http, 'SynchronousRequest', @resp OUT, 'api.zoom.us', 443, 1, @req
EXEC sp_OAGetProperty @http, 'LastMethodSuccess', @iTmp0 OUT
IF @iTmp0 = 0
BEGIN
EXEC sp_OAGetProperty @http, 'LastErrorText', @sTmp0 OUT
PRINT @sTmp0
EXEC @hr = sp_OADestroy @http
EXEC @hr = sp_OADestroy @req
RETURN
END
DECLARE @respStatusCode int
EXEC sp_OAGetProperty @resp, 'StatusCode', @respStatusCode OUT
PRINT 'Response Status Code = ' + @respStatusCode
IF @respStatusCode <> 204
BEGIN
PRINT 'Response Header:'
EXEC sp_OAGetProperty @resp, 'Header', @sTmp0 OUT
PRINT @sTmp0
PRINT 'Response Body:'
EXEC sp_OAGetProperty @resp, 'BodyStr', @sTmp0 OUT
PRINT @sTmp0
PRINT 'Failed.'
EXEC @hr = sp_OADestroy @resp
EXEC @hr = sp_OADestroy @http
EXEC @hr = sp_OADestroy @req
RETURN
END
EXEC @hr = sp_OADestroy @resp
PRINT 'Success.'
EXEC @hr = sp_OADestroy @http
EXEC @hr = sp_OADestroy @req
END
GO
Curl Command
curl -X PATCH
-H "Authorization: Bearer <access_token>"
-H "Content-Type: multipart/form-data"
--form 'first_name=in nu'
--form 'last_name=in nuelit'
--form 'type=in nuelit99'
--form 'pmi=in nuelit99-25518892'
--form 'use_pmi=in nuelit99-25518892false'
--form 'timezone=in nuelit99-25518892falseanim ipsum in'
--form 'language=in nuelit99-25518892falseanim ipsum indolor veniam cupidatat'
--form 'dept=in nuelit99-25518892falseanim ipsum indolor veniam cupidatatdolor tempor'
--form 'vanity_name=in nuelit99-25518892falseanim ipsum indolor veniam cupidatatdolor temporin quis dolor labore'
--form 'host_key=in nuelit99-25518892falseanim ipsum indolor veniam cupidatatdolor temporin quis dolor laboreenim p'
--form 'cms_user_id=in nuelit99-25518892falseanim ipsum indolor veniam cupidatatdolor temporin quis dolor laboreenim pnisi commodo Ut'
--form 'job_title=in nuelit99-25518892falseanim ipsum indolor veniam cupidatatdolor temporin quis dolor laboreenim pnisi commodo Utnisi elit fugiat'
--form 'company=in nuelit99-25518892falseanim ipsum indolor veniam cupidatatdolor temporin quis dolor laboreenim pnisi commodo Utnisi elit fugiatdolore mollit enim ex'
--form 'location=in nuelit99-25518892falseanim ipsum indolor veniam cupidatatdolor temporin quis dolor laboreenim pnisi commodo Utnisi elit fugiatdolore mollit enim exreprehenderit laboris esse dolore'
--form 'phone_number=in nuelit99-25518892falseanim ipsum indolor veniam cupidatatdolor temporin quis dolor laboreenim pnisi commodo Utnisi elit fugiatdolore mollit enim exreprehenderit laboris esse doloreproident incididunt'
--form 'phone_country=in nuelit99-25518892falseanim ipsum indolor veniam cupidatatdolor temporin quis dolor laboreenim pnisi commodo Utnisi elit fugiatdolore mollit enim exreprehenderit laboris esse doloreproident incididuntmollit labore et laborum'
--form 'custom_attributes=in nuelit99-25518892falseanim ipsum indolor veniam cupidatatdolor temporin quis dolor laboreenim pnisi commodo Utnisi elit fugiatdolore mollit enim exreprehenderit laboris esse doloreproident incididuntmollit labore et laborum{"key":"fugiat","name":"reprehenderit ullamco sit fugiat","value":"incididunt"}'
--form 'group_id=in nuelit99-25518892falseanim ipsum indolor veniam cupidatatdolor temporin quis dolor laboreenim pnisi commodo Utnisi elit fugiatdolore mollit enim exreprehenderit laboris esse doloreproident incididuntmollit labore et laborum{"key":"fugiat","name":"reprehenderit ullamco sit fugiat","value":"incididunt"}amet Lorem reprehenderit eu sed'
--form 'phone_numbers=in nuelit99-25518892falseanim ipsum indolor veniam cupidatatdolor temporin quis dolor laboreenim pnisi commodo Utnisi elit fugiatdolore mollit enim exreprehenderit laboris esse doloreproident incididuntmollit labore et laborum{"key":"fugiat","name":"reprehenderit ullamco sit fugiat","value":"incididunt"}amet Lorem reprehenderit eu sed{"country":"ut ullamco ea","code":"ad adipisicing","number":"eiusmod ipsum enim","label":"Home"}'
--form 'manager=in nuelit99-25518892falseanim ipsum indolor veniam cupidatatdolor temporin quis dolor laboreenim pnisi commodo Utnisi elit fugiatdolore mollit enim exreprehenderit laboris esse doloreproident incididuntmollit labore et laborum{"key":"fugiat","name":"reprehenderit ullamco sit fugiat","value":"incididunt"}amet Lorem reprehenderit eu sed{"country":"ut ullamco ea","code":"ad adipisicing","number":"eiusmod ipsum enim","label":"Home"}H-BwfF@h.qxj'
--form 'pronouns=in nuelit99-25518892falseanim ipsum indolor veniam cupidatatdolor temporin quis dolor laboreenim pnisi commodo Utnisi elit fugiatdolore mollit enim exreprehenderit laboris esse doloreproident incididuntmollit labore et laborum{"key":"fugiat","name":"reprehenderit ullamco sit fugiat","value":"incididunt"}amet Lorem reprehenderit eu sed{"country":"ut ullamco ea","code":"ad adipisicing","number":"eiusmod ipsum enim","label":"Home"}H-BwfF@h.qxjexercitation laboris'
--form 'pronouns_option=in nuelit99-25518892falseanim ipsum indolor veniam cupidatatdolor temporin quis dolor laboreenim pnisi commodo Utnisi elit fugiatdolore mollit enim exreprehenderit laboris esse doloreproident incididuntmollit labore et laborum{"key":"fugiat","name":"reprehenderit ullamco sit fugiat","value":"incididunt"}amet Lorem reprehenderit eu sed{"country":"ut ullamco ea","code":"ad adipisicing","number":"eiusmod ipsum enim","label":"Home"}H-BwfF@h.qxjexercitation laboris2'
https://api.zoom.us/v2/users/:userId?login_type=100&remove_tsp_credentials=true
Postman Collection Item JSON
{
"name": "Update a user",
"request": {
"method": "PATCH",
"header": [
{
"key": "Content-Type",
"value": "multipart/form-data"
}
],
"body": {
"mode": "formdata",
"formdata": [
{
"key": "first_name",
"value": "in nu",
"description": "User's first name. Cannot contain more than 5 Chinese characters.",
"type": "text"
},
{
"key": "last_name",
"value": "elit ",
"description": "User's last name. Cannot contain more than 5 Chinese characters.",
"type": "text"
},
{
"key": "type",
"value": "99",
"description": "User types:<br>`1` - Basic.<br>`2` - Licensed.<br>`3` - On-prem.<br>`99` - None (this can only be set with `ssoCreate`). (This can only be one of 1,2,3,99)",
"type": "text"
},
{
"key": "pmi",
"value": "-25518892",
"description": "Personal meeting ID: length must be 10.",
"type": "text"
},
{
"key": "use_pmi",
"value": "false",
"description": "Use Personal Meeting ID for instant meetings.",
"type": "text"
},
{
"key": "timezone",
"value": "anim ipsum in",
"description": "The time zone ID for a user profile. For this parameter value please refer to the ID value in the [timezone](https://marketplace.zoom.us/docs/api-reference/other-references/abbreviation-lists#timezones) list.",
"type": "text"
},
{
"key": "language",
"value": "dolor veniam cupidatat",
"description": "language",
"type": "text"
},
{
"key": "dept",
"value": "dolor tempor",
"description": "Department for user profile: use for report.",
"type": "text"
},
{
"key": "vanity_name",
"value": "in quis dolor labore",
"description": "Personal meeting room name.",
"type": "text"
},
{
"key": "host_key",
"value": "enim p",
"description": "Host key. It should be a 6-10 digit number.",
"type": "text"
},
{
"key": "cms_user_id",
"value": "nisi commodo Ut",
"description": "Kaltura user ID.",
"type": "text"
},
{
"key": "job_title",
"value": "nisi elit fugiat",
"description": "User's job title.",
"type": "text"
},
{
"key": "company",
"value": "dolore mollit enim ex",
"description": "User's company.",
"type": "text"
},
{
"key": "location",
"value": "reprehenderit laboris esse dolore",
"description": "User's location.",
"type": "text"
},
{
"key": "phone_number",
"value": "proident incididunt",
"description": "**Note:** This field has been **deprecated** and will not be supported in the future. Use the **phone_numbers** field instead to assign phone number(s) to a user.\n\n\nPhone number of the user. To update a phone number, you must also provide the `phone_country` field.",
"type": "text"
},
{
"key": "phone_country",
"value": "mollit labore et laborum",
"description": "**Note:** This field has been **deprecated** and will not be supported in the future. Use the **country** field of the **phone_numbers** object instead to select the country for the phone number.\n\n\n\n[Country ID](https://marketplace.zoom.us/docs/api-reference/other-references/abbreviation-lists#countries) of the phone number. For example, if the phone number provided in the `phone_number` field is a Brazil based number, the value of the `phone_country` field should be `BR`.",
"type": "text"
},
{
"key": "custom_attributes",
"value": "{\"key\":\"fugiat\",\"name\":\"reprehenderit ullamco sit fugiat\",\"value\":\"incididunt\"}",
"description": "Custom attribute(s) of the user.",
"type": "text"
},
{
"key": "group_id",
"value": "amet Lorem reprehenderit eu sed",
"description": "Provide unique identifier of the group that you would like to add a [pending user](https://support.zoom.us/hc/en-us/articles/201363183-Managing-users#h_13c87a2a-ecd6-40ad-be61-a9935e660edb) to. The value of this field can be retrieved from [List Groups](https://marketplace.zoom.us/docs/api-reference/zoom-api/groups/groups) API.",
"type": "text"
},
{
"key": "phone_numbers",
"value": "{\"country\":\"ut ullamco ea\",\"code\":\"ad adipisicing\",\"number\":\"eiusmod ipsum enim\",\"label\":\"Home\"}",
"type": "text"
},
{
"key": "manager",
"value": "H-BwfF@h.qxj",
"description": "The manager for the user.",
"type": "text"
},
{
"key": "pronouns",
"value": "exercitation laboris",
"description": "The user's pronouns.",
"type": "text"
},
{
"key": "pronouns_option",
"value": "2",
"description": "The user's display pronouns setting:\n* `1` — Ask the user every time they join meetings and webinars. \n* `2` — Always display pronouns in meetings and webinars. \n* `3` — Do not display pronouns in meetings and webinars. (This can only be one of 1,2,3)",
"type": "text"
}
]
},
"url": {
"raw": "{{baseUrl}}/users/:userId?login_type=100&remove_tsp_credentials=true",
"host": [
"{{baseUrl}}"
],
"path": [
"users",
":userId"
],
"query": [
{
"key": "login_type",
"value": "100",
"description": "The user's login method:\n\n`0` — Facebook OAuth</br>`1` — Google OAuth</br>`24` — Apple OAuth</br>`27` — Microsoft OAuth</br>`97` — Mobile device</br>`98` — RingCentral OAuth</br>`99` — API user</br>`100` — Zoom Work email</br>`101` — Single Sign-On (SSO)\n\nThe following login methods are only available in China:\n\n`11` — Phone number</br>`21` — WeChat</br>`23` — Alipay"
},
{
"key": "remove_tsp_credentials",
"value": "true",
"description": "Whether need to remove TSP credentials: \n* `true` — Need to remove TSP credentials. \n* `false` — Not need to remove TSP credentials. \n\n This value defaults to `false` (null)."
}
],
"variable": [
{
"key": "userId",
"value": "quis officia in reprehenderit",
"description": "(Required) The user ID or email address of the user. For user-level apps, pass the `me` value for this parameter."
}
]
},
"description": "Update information on a user's [Zoom profile](https://support.zoom.us/hc/en-us/articles/201363203-My-Profile). For user-level apps, pass [the `me` value](https://marketplace.zoom.us/docs/api-reference/using-zoom-apis#mekeyword) instead of the `userId` parameter.\n\n**Scopes:** `user:write:admin` `user:write`<br>**[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `Light`"
},
"response": [
{
"name": "**HTTP Status Code:** `204` <br> \nUser updated.",
"originalRequest": {
"method": "PATCH",
"header": [
{
"description": "Added as a part of security scheme: oauth2",
"key": "Authorization",
"value": "<token>"
}
],
"body": {
"mode": "formdata",
"formdata": [
{
"key": "first_name",
"value": "in nu",
"description": "User's first name. Cannot contain more than 5 Chinese characters.",
"type": "text"
},
{
"key": "last_name",
"value": "elit ",
"description": "User's last name. Cannot contain more than 5 Chinese characters.",
"type": "text"
},
{
"key": "type",
"value": "99",
"description": "User types:<br>`1` - Basic.<br>`2` - Licensed.<br>`3` - On-prem.<br>`99` - None (this can only be set with `ssoCreate`). (This can only be one of 1,2,3,99)",
"type": "text"
},
{
"key": "pmi",
"value": "-25518892",
"description": "Personal meeting ID: length must be 10.",
"type": "text"
},
{
"key": "use_pmi",
"value": "false",
"description": "Use Personal Meeting ID for instant meetings.",
"type": "text"
},
{
"key": "timezone",
"value": "anim ipsum in",
"description": "The time zone ID for a user profile. For this parameter value please refer to the ID value in the [timezone](https://marketplace.zoom.us/docs/api-reference/other-references/abbreviation-lists#timezones) list.",
"type": "text"
},
{
"key": "language",
"value": "dolor veniam cupidatat",
"description": "language",
"type": "text"
},
{
"key": "dept",
"value": "dolor tempor",
"description": "Department for user profile: use for report.",
"type": "text"
},
{
"key": "vanity_name",
"value": "in quis dolor labore",
"description": "Personal meeting room name.",
"type": "text"
},
{
"key": "host_key",
"value": "enim p",
"description": "Host key. It should be a 6-10 digit number.",
"type": "text"
},
{
"key": "cms_user_id",
"value": "nisi commodo Ut",
"description": "Kaltura user ID.",
"type": "text"
},
{
"key": "job_title",
"value": "nisi elit fugiat",
"description": "User's job title.",
"type": "text"
},
{
"key": "company",
"value": "dolore mollit enim ex",
"description": "User's company.",
"type": "text"
},
{
"key": "location",
"value": "reprehenderit laboris esse dolore",
"description": "User's location.",
"type": "text"
},
{
"key": "phone_number",
"value": "proident incididunt",
"description": "**Note:** This field has been **deprecated** and will not be supported in the future. Use the **phone_numbers** field instead to assign phone number(s) to a user.\n\n\nPhone number of the user. To update a phone number, you must also provide the `phone_country` field.",
"type": "text"
},
{
"key": "phone_country",
"value": "mollit labore et laborum",
"description": "**Note:** This field has been **deprecated** and will not be supported in the future. Use the **country** field of the **phone_numbers** object instead to select the country for the phone number.\n\n\n\n[Country ID](https://marketplace.zoom.us/docs/api-reference/other-references/abbreviation-lists#countries) of the phone number. For example, if the phone number provided in the `phone_number` field is a Brazil based number, the value of the `phone_country` field should be `BR`.",
"type": "text"
},
{
"key": "custom_attributes",
"value": "{\"key\":\"fugiat\",\"name\":\"reprehenderit ullamco sit fugiat\",\"value\":\"incididunt\"}",
"description": "Custom attribute(s) of the user.",
"type": "text"
},
{
"key": "group_id",
"value": "amet Lorem reprehenderit eu sed",
"description": "Provide unique identifier of the group that you would like to add a [pending user](https://support.zoom.us/hc/en-us/articles/201363183-Managing-users#h_13c87a2a-ecd6-40ad-be61-a9935e660edb) to. The value of this field can be retrieved from [List Groups](https://marketplace.zoom.us/docs/api-reference/zoom-api/groups/groups) API.",
"type": "text"
},
{
"key": "phone_numbers",
"value": "{\"country\":\"ut ullamco ea\",\"code\":\"ad adipisicing\",\"number\":\"eiusmod ipsum enim\",\"label\":\"Home\"}",
"type": "text"
},
{
"key": "manager",
"value": "H-BwfF@h.qxj",
"description": "The manager for the user.",
"type": "text"
},
{
"key": "pronouns",
"value": "exercitation laboris",
"description": "The user's pronouns.",
"type": "text"
},
{
"key": "pronouns_option",
"value": "2",
"description": "The user's display pronouns setting:\n* `1` — Ask the user every time they join meetings and webinars. \n* `2` — Always display pronouns in meetings and webinars. \n* `3` — Do not display pronouns in meetings and webinars. (This can only be one of 1,2,3)",
"type": "text"
}
]
},
"url": {
"raw": "{{baseUrl}}/users/:userId?login_type=100&remove_tsp_credentials=true",
"host": [
"{{baseUrl}}"
],
"path": [
"users",
":userId"
],
"query": [
{
"key": "login_type",
"value": "100"
},
{
"key": "remove_tsp_credentials",
"value": "true"
}
],
"variable": [
{
"key": "userId",
"value": "quis officia in reprehenderit",
"description": "(Required) The user ID or email address of the user. For user-level apps, pass the `me` value for this parameter."
}
]
}
},
"status": "No Content",
"code": 204,
"_postman_previewlanguage": "text",
"header": [
{
"key": "Content-Type",
"value": "text/plain"
}
],
"cookie": [
],
"body": ""
},
{
"name": "**HTTP Status Code:** `400` **Bad Request**<br><br>\n**Error Code:** `200`<br>A Zoom Room user cannot be updated to a free user type: $userId<br>Only an account administrator can change a user's name. <br>Only an account administrator can change the host k",
"originalRequest": {
"method": "PATCH",
"header": [
{
"description": "Added as a part of security scheme: oauth2",
"key": "Authorization",
"value": "<token>"
}
],
"body": {
"mode": "formdata",
"formdata": [
{
"key": "first_name",
"value": "in nu",
"description": "User's first name. Cannot contain more than 5 Chinese characters.",
"type": "text"
},
{
"key": "last_name",
"value": "elit ",
"description": "User's last name. Cannot contain more than 5 Chinese characters.",
"type": "text"
},
{
"key": "type",
"value": "99",
"description": "User types:<br>`1` - Basic.<br>`2` - Licensed.<br>`3` - On-prem.<br>`99` - None (this can only be set with `ssoCreate`). (This can only be one of 1,2,3,99)",
"type": "text"
},
{
"key": "pmi",
"value": "-25518892",
"description": "Personal meeting ID: length must be 10.",
"type": "text"
},
{
"key": "use_pmi",
"value": "false",
"description": "Use Personal Meeting ID for instant meetings.",
"type": "text"
},
{
"key": "timezone",
"value": "anim ipsum in",
"description": "The time zone ID for a user profile. For this parameter value please refer to the ID value in the [timezone](https://marketplace.zoom.us/docs/api-reference/other-references/abbreviation-lists#timezones) list.",
"type": "text"
},
{
"key": "language",
"value": "dolor veniam cupidatat",
"description": "language",
"type": "text"
},
{
"key": "dept",
"value": "dolor tempor",
"description": "Department for user profile: use for report.",
"type": "text"
},
{
"key": "vanity_name",
"value": "in quis dolor labore",
"description": "Personal meeting room name.",
"type": "text"
},
{
"key": "host_key",
"value": "enim p",
"description": "Host key. It should be a 6-10 digit number.",
"type": "text"
},
{
"key": "cms_user_id",
"value": "nisi commodo Ut",
"description": "Kaltura user ID.",
"type": "text"
},
{
"key": "job_title",
"value": "nisi elit fugiat",
"description": "User's job title.",
"type": "text"
},
{
"key": "company",
"value": "dolore mollit enim ex",
"description": "User's company.",
"type": "text"
},
{
"key": "location",
"value": "reprehenderit laboris esse dolore",
"description": "User's location.",
"type": "text"
},
{
"key": "phone_number",
"value": "proident incididunt",
"description": "**Note:** This field has been **deprecated** and will not be supported in the future. Use the **phone_numbers** field instead to assign phone number(s) to a user.\n\n\nPhone number of the user. To update a phone number, you must also provide the `phone_country` field.",
"type": "text"
},
{
"key": "phone_country",
"value": "mollit labore et laborum",
"description": "**Note:** This field has been **deprecated** and will not be supported in the future. Use the **country** field of the **phone_numbers** object instead to select the country for the phone number.\n\n\n\n[Country ID](https://marketplace.zoom.us/docs/api-reference/other-references/abbreviation-lists#countries) of the phone number. For example, if the phone number provided in the `phone_number` field is a Brazil based number, the value of the `phone_country` field should be `BR`.",
"type": "text"
},
{
"key": "custom_attributes",
"value": "{\"key\":\"fugiat\",\"name\":\"reprehenderit ullamco sit fugiat\",\"value\":\"incididunt\"}",
"description": "Custom attribute(s) of the user.",
"type": "text"
},
{
"key": "group_id",
"value": "amet Lorem reprehenderit eu sed",
"description": "Provide unique identifier of the group that you would like to add a [pending user](https://support.zoom.us/hc/en-us/articles/201363183-Managing-users#h_13c87a2a-ecd6-40ad-be61-a9935e660edb) to. The value of this field can be retrieved from [List Groups](https://marketplace.zoom.us/docs/api-reference/zoom-api/groups/groups) API.",
"type": "text"
},
{
"key": "phone_numbers",
"value": "{\"country\":\"ut ullamco ea\",\"code\":\"ad adipisicing\",\"number\":\"eiusmod ipsum enim\",\"label\":\"Home\"}",
"type": "text"
},
{
"key": "manager",
"value": "H-BwfF@h.qxj",
"description": "The manager for the user.",
"type": "text"
},
{
"key": "pronouns",
"value": "exercitation laboris",
"description": "The user's pronouns.",
"type": "text"
},
{
"key": "pronouns_option",
"value": "2",
"description": "The user's display pronouns setting:\n* `1` — Ask the user every time they join meetings and webinars. \n* `2` — Always display pronouns in meetings and webinars. \n* `3` — Do not display pronouns in meetings and webinars. (This can only be one of 1,2,3)",
"type": "text"
}
]
},
"url": {
"raw": "{{baseUrl}}/users/:userId?login_type=100&remove_tsp_credentials=true",
"host": [
"{{baseUrl}}"
],
"path": [
"users",
":userId"
],
"query": [
{
"key": "login_type",
"value": "100"
},
{
"key": "remove_tsp_credentials",
"value": "true"
}
],
"variable": [
{
"key": "userId",
"value": "quis officia in reprehenderit",
"description": "(Required) The user ID or email address of the user. For user-level apps, pass the `me` value for this parameter."
}
]
}
},
"status": "Bad Request",
"code": 400,
"_postman_previewlanguage": "text",
"header": [
{
"key": "Content-Type",
"value": "text/plain"
}
],
"cookie": [
],
"body": ""
},
{
"name": "**HTTP Status Code:** `404`<br>\n**Error Code:** `1001`<br>\nUser does not exist: $userId.<br>",
"originalRequest": {
"method": "PATCH",
"header": [
{
"description": "Added as a part of security scheme: oauth2",
"key": "Authorization",
"value": "<token>"
}
],
"body": {
"mode": "formdata",
"formdata": [
{
"key": "first_name",
"value": "in nu",
"description": "User's first name. Cannot contain more than 5 Chinese characters.",
"type": "text"
},
{
"key": "last_name",
"value": "elit ",
"description": "User's last name. Cannot contain more than 5 Chinese characters.",
"type": "text"
},
{
"key": "type",
"value": "99",
"description": "User types:<br>`1` - Basic.<br>`2` - Licensed.<br>`3` - On-prem.<br>`99` - None (this can only be set with `ssoCreate`). (This can only be one of 1,2,3,99)",
"type": "text"
},
{
"key": "pmi",
"value": "-25518892",
"description": "Personal meeting ID: length must be 10.",
"type": "text"
},
{
"key": "use_pmi",
"value": "false",
"description": "Use Personal Meeting ID for instant meetings.",
"type": "text"
},
{
"key": "timezone",
"value": "anim ipsum in",
"description": "The time zone ID for a user profile. For this parameter value please refer to the ID value in the [timezone](https://marketplace.zoom.us/docs/api-reference/other-references/abbreviation-lists#timezones) list.",
"type": "text"
},
{
"key": "language",
"value": "dolor veniam cupidatat",
"description": "language",
"type": "text"
},
{
"key": "dept",
"value": "dolor tempor",
"description": "Department for user profile: use for report.",
"type": "text"
},
{
"key": "vanity_name",
"value": "in quis dolor labore",
"description": "Personal meeting room name.",
"type": "text"
},
{
"key": "host_key",
"value": "enim p",
"description": "Host key. It should be a 6-10 digit number.",
"type": "text"
},
{
"key": "cms_user_id",
"value": "nisi commodo Ut",
"description": "Kaltura user ID.",
"type": "text"
},
{
"key": "job_title",
"value": "nisi elit fugiat",
"description": "User's job title.",
"type": "text"
},
{
"key": "company",
"value": "dolore mollit enim ex",
"description": "User's company.",
"type": "text"
},
{
"key": "location",
"value": "reprehenderit laboris esse dolore",
"description": "User's location.",
"type": "text"
},
{
"key": "phone_number",
"value": "proident incididunt",
"description": "**Note:** This field has been **deprecated** and will not be supported in the future. Use the **phone_numbers** field instead to assign phone number(s) to a user.\n\n\nPhone number of the user. To update a phone number, you must also provide the `phone_country` field.",
"type": "text"
},
{
"key": "phone_country",
"value": "mollit labore et laborum",
"description": "**Note:** This field has been **deprecated** and will not be supported in the future. Use the **country** field of the **phone_numbers** object instead to select the country for the phone number.\n\n\n\n[Country ID](https://marketplace.zoom.us/docs/api-reference/other-references/abbreviation-lists#countries) of the phone number. For example, if the phone number provided in the `phone_number` field is a Brazil based number, the value of the `phone_country` field should be `BR`.",
"type": "text"
},
{
"key": "custom_attributes",
"value": "{\"key\":\"fugiat\",\"name\":\"reprehenderit ullamco sit fugiat\",\"value\":\"incididunt\"}",
"description": "Custom attribute(s) of the user.",
"type": "text"
},
{
"key": "group_id",
"value": "amet Lorem reprehenderit eu sed",
"description": "Provide unique identifier of the group that you would like to add a [pending user](https://support.zoom.us/hc/en-us/articles/201363183-Managing-users#h_13c87a2a-ecd6-40ad-be61-a9935e660edb) to. The value of this field can be retrieved from [List Groups](https://marketplace.zoom.us/docs/api-reference/zoom-api/groups/groups) API.",
"type": "text"
},
{
"key": "phone_numbers",
"value": "{\"country\":\"ut ullamco ea\",\"code\":\"ad adipisicing\",\"number\":\"eiusmod ipsum enim\",\"label\":\"Home\"}",
"type": "text"
},
{
"key": "manager",
"value": "H-BwfF@h.qxj",
"description": "The manager for the user.",
"type": "text"
},
{
"key": "pronouns",
"value": "exercitation laboris",
"description": "The user's pronouns.",
"type": "text"
},
{
"key": "pronouns_option",
"value": "2",
"description": "The user's display pronouns setting:\n* `1` — Ask the user every time they join meetings and webinars. \n* `2` — Always display pronouns in meetings and webinars. \n* `3` — Do not display pronouns in meetings and webinars. (This can only be one of 1,2,3)",
"type": "text"
}
]
},
"url": {
"raw": "{{baseUrl}}/users/:userId?login_type=100&remove_tsp_credentials=true",
"host": [
"{{baseUrl}}"
],
"path": [
"users",
":userId"
],
"query": [
{
"key": "login_type",
"value": "100"
},
{
"key": "remove_tsp_credentials",
"value": "true"
}
],
"variable": [
{
"key": "userId",
"value": "quis officia in reprehenderit",
"description": "(Required) The user ID or email address of the user. For user-level apps, pass the `me` value for this parameter."
}
]
}
},
"status": "Not Found",
"code": 404,
"_postman_previewlanguage": "text",
"header": [
{
"key": "Content-Type",
"value": "text/plain"
}
],
"cookie": [
],
"body": ""
}
]
}
