Powershell / Zoom API / Create a sub account
Back to Collection Items
Add-Type -Path "C:\chilkat\ChilkatDotNet47-x64\ChilkatDotNet47.dll"
# This example assumes the Chilkat API to have been previously unlocked.
# See Global Unlock Sample for sample code.
$http = New-Object Chilkat.Http
$req = New-Object Chilkat.HttpRequest
$req.HttpVerb = "POST"
$req.Path = "/v2/accounts"
$req.ContentType = "multipart/form-data"
$req.AddParam("first_name","e")
$req.AddParam("last_name","ealiquip mollit")
$req.AddParam("email","ealiquip mollitnon Ut dolor c")
$req.AddParam("password","ealiquip mollitnon Ut dolor cdolore dolor velit cupidatat")
$req.AddParam("options","ealiquip mollitnon Ut dolor cdolore dolor velit cupidatat{`"share_rc`":false,`"room_connector_list`":[`"irure est`",`"aliquip culpa mollit ullamco Lorem`"],`"share_mc`":false,`"meeting_connector_list`":[`"do`",`"deserunt nisi aliqu`"],`"pay_mode`":`"master`",`"billing_auto_renew`":true}")
$req.AddParam("account_name","ealiquip mollitnon Ut dolor cdolore dolor velit cupidatat{`"share_rc`":false,`"room_connector_list`":[`"irure est`",`"aliquip culpa mollit ullamco Lorem`"],`"share_mc`":false,`"meeting_connector_list`":[`"do`",`"deserunt nisi aliqu`"],`"pay_mode`":`"master`",`"billing_auto_renew`":true}qui cillum eu labore")
$req.AddParam("sub_reseller_id","ealiquip mollitnon Ut dolor cdolore dolor velit cupidatat{`"share_rc`":false,`"room_connector_list`":[`"irure est`",`"aliquip culpa mollit ullamco Lorem`"],`"share_mc`":false,`"meeting_connector_list`":[`"do`",`"deserunt nisi aliqu`"],`"pay_mode`":`"master`",`"billing_auto_renew`":true}qui cillum eu laboreLorem amet dolor ex nisi")
$req.AddHeader("Authorization","Bearer <access_token>")
$resp = $http.SynchronousRequest("api.zoom.us",443,$true,$req)
if ($http.LastMethodSuccess -eq $false) {
$($http.LastErrorText)
exit
}
$sbResponseBody = New-Object Chilkat.StringBuilder
$resp.GetBodySb($sbResponseBody)
$jResp = New-Object Chilkat.JsonObject
$jResp.LoadSb($sbResponseBody)
$jResp.EmitCompact = $false
$("Response Body:")
$($jResp.Emit())
$respStatusCode = $resp.StatusCode
$("Response Status Code = " + $respStatusCode)
if ($respStatusCode -ge 400) {
$("Response Header:")
$($resp.Header)
$("Failed.")
exit
}
# Sample JSON response:
# (Sample code for parsing the JSON response is shown below)
# {
# "id": "string",
# "owner_id": "string",
# "owner_email": "string",
# "created_at": "string"
# }
# Sample code for parsing the JSON response...
# Use this online tool to generate parsing code from sample JSON: Generate JSON Parsing Code
$id = $jResp.StringOf("id")
$owner_id = $jResp.StringOf("owner_id")
$owner_email = $jResp.StringOf("owner_email")
$created_at = $jResp.StringOf("created_at")
Curl Command
curl -X POST
-H "Authorization: Bearer <access_token>"
-H "Content-Type: multipart/form-data"
--form 'first_name=e'
--form 'last_name=ealiquip mollit'
--form 'email=ealiquip mollitnon Ut dolor c'
--form 'password=ealiquip mollitnon Ut dolor cdolore dolor velit cupidatat'
--form 'options=ealiquip mollitnon Ut dolor cdolore dolor velit cupidatat{"share_rc":false,"room_connector_list":["irure est","aliquip culpa mollit ullamco Lorem"],"share_mc":false,"meeting_connector_list":["do","deserunt nisi aliqu"],"pay_mode":"master","billing_auto_renew":true}'
--form 'account_name=ealiquip mollitnon Ut dolor cdolore dolor velit cupidatat{"share_rc":false,"room_connector_list":["irure est","aliquip culpa mollit ullamco Lorem"],"share_mc":false,"meeting_connector_list":["do","deserunt nisi aliqu"],"pay_mode":"master","billing_auto_renew":true}qui cillum eu labore'
--form 'sub_reseller_id=ealiquip mollitnon Ut dolor cdolore dolor velit cupidatat{"share_rc":false,"room_connector_list":["irure est","aliquip culpa mollit ullamco Lorem"],"share_mc":false,"meeting_connector_list":["do","deserunt nisi aliqu"],"pay_mode":"master","billing_auto_renew":true}qui cillum eu laboreLorem amet dolor ex nisi'
https://api.zoom.us/v2/accounts
Postman Collection Item JSON
{
"name": "Create a sub account",
"request": {
"method": "POST",
"header": [
{
"key": "Content-Type",
"value": "multipart/form-data"
}
],
"body": {
"mode": "formdata",
"formdata": [
{
"key": "first_name",
"value": "e",
"description": "(Required) User's first name.",
"type": "text"
},
{
"key": "last_name",
"value": "aliquip mollit",
"description": "(Required) User's last name.",
"type": "text"
},
{
"key": "email",
"value": "non Ut dolor c",
"description": "(Required) User's email address.",
"type": "text"
},
{
"key": "password",
"value": "dolore dolor velit cupidatat",
"description": "(Required) User's password.\n\n**Note:** If the account owner or admin has enabled [enhanced password requirements](https://support.zoom.us/hc/en-us/articles/360034675592-Advanced-security-settings#h_fa9186e4-6818-4f7a-915c-2e25c19f0acd), the value provided in this field must meet those requirements. These requirements can be retrieved by calling the [Get Account Settings API](https://marketplace.zoom.us/docs/api-reference/zoom-api/accounts/accountsettings) and referring to the `password_requirement` field present in the `security` object.",
"type": "text"
},
{
"key": "options",
"value": "{\"share_rc\":false,\"room_connector_list\":[\"irure est\",\"aliquip culpa mollit ullamco Lorem\"],\"share_mc\":false,\"meeting_connector_list\":[\"do\",\"deserunt nisi aliqu\"],\"pay_mode\":\"master\",\"billing_auto_renew\":true}",
"description": "Account options object.",
"type": "text"
},
{
"key": "account_name",
"value": "qui cillum eu labore",
"description": "Name of the account. If you do not provide a value for this field, by default, the value will be set as a concatenation of \"first_name\" and \"last_name\". ",
"type": "text"
},
{
"key": "sub_reseller_id",
"value": "Lorem amet dolor ex nisi",
"description": "The sub-reseller's ID.\n\nIf you do not provide this field in the payload, a new subaccount will be created for the requested account.",
"type": "text"
}
]
},
"url": {
"raw": "{{baseUrl}}/accounts",
"host": [
"{{baseUrl}}"
],
"path": [
"accounts"
]
},
"description": "Create a sub account under a master account. Your account must be a master account in order to create sub accounts. \n<br><br>Zoom allows only [approved partners](https://marketplace.zoom.us/docs/api-reference/master-account-apis) to use master APIs and manage sub accounts. Email the partner programs team at partner-success@zoom.us. for more details. Please note that the created account user will receive a confirmation email.<br><br>\n<br>\n**Prerequisites:**<br>\n* Pro or a higher paid account with master account option enabled. <br>\n\n**Scope**: `account:write:admin`<br>\n**[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `Light`<br>\n\n\n "
},
"response": [
{
"name": "Account created.",
"originalRequest": {
"method": "POST",
"header": [
{
"description": "Added as a part of security scheme: oauth2",
"key": "Authorization",
"value": "<token>"
}
],
"body": {
"mode": "formdata",
"formdata": [
{
"key": "first_name",
"value": "Ut",
"description": "(Required) User's first name.",
"type": "text"
},
{
"key": "last_name",
"value": "do mollit",
"description": "(Required) User's last name.",
"type": "text"
},
{
"key": "email",
"value": "esse Duis",
"description": "(Required) User's email address.",
"type": "text"
},
{
"key": "password",
"value": "Duis id elit dolor",
"description": "(Required) User's password.\n\n**Note:** If the account owner or admin has enabled [enhanced password requirements](https://support.zoom.us/hc/en-us/articles/360034675592-Advanced-security-settings#h_fa9186e4-6818-4f7a-915c-2e25c19f0acd), the value provided in this field must meet those requirements. These requirements can be retrieved by calling the [Get Account Settings API](https://marketplace.zoom.us/docs/api-reference/zoom-api/accounts/accountsettings) and referring to the `password_requirement` field present in the `security` object.",
"type": "text"
},
{
"key": "options",
"value": "{\"share_rc\":false,\"room_connector_list\":[\"ea dolore nisi magna\",\"in proident ut\"],\"share_mc\":false,\"meeting_connector_list\":[\"irure ad\",\"laborum\"],\"pay_mode\":\"master\",\"billing_auto_renew\":true}",
"description": "Account options object.",
"type": "text"
},
{
"key": "account_name",
"value": "aute sint ullamco",
"description": "Name of the account. If you do not provide a value for this field, by default, the value will be set as a concatenation of \"first_name\" and \"last_name\". ",
"type": "text"
},
{
"key": "sub_reseller_id",
"value": "eiusmod labore aliquip",
"description": "The sub-reseller's ID.\n\nIf you do not provide this field in the payload, a new subaccount will be created for the requested account.",
"type": "text"
}
]
},
"url": {
"raw": "{{baseUrl}}/accounts",
"host": [
"{{baseUrl}}"
],
"path": [
"accounts"
]
}
},
"status": "Created",
"code": 201,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Location",
"value": "quis officia in reprehenderit",
"description": "Location of the created account."
},
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [
],
"body": "{\n \"id\": \"string\",\n \"owner_id\": \"string\",\n \"owner_email\": \"string\",\n \"created_at\": \"string\"\n}"
},
{
"name": "**HTTP Status Code:** `400`<br>\n**Error Code:**`300`<br> Your request could not be completed because the name contains an invalid word: {name}<br> Your request was not accepted because \"{field}\" contains special character(s).\n**Error Code:** `1107`<br>\nEm",
"originalRequest": {
"method": "POST",
"header": [
{
"description": "Added as a part of security scheme: oauth2",
"key": "Authorization",
"value": "<token>"
}
],
"body": {
"mode": "formdata",
"formdata": [
{
"key": "first_name",
"value": "Ut",
"description": "(Required) User's first name.",
"type": "text"
},
{
"key": "last_name",
"value": "do mollit",
"description": "(Required) User's last name.",
"type": "text"
},
{
"key": "email",
"value": "esse Duis",
"description": "(Required) User's email address.",
"type": "text"
},
{
"key": "password",
"value": "Duis id elit dolor",
"description": "(Required) User's password.\n\n**Note:** If the account owner or admin has enabled [enhanced password requirements](https://support.zoom.us/hc/en-us/articles/360034675592-Advanced-security-settings#h_fa9186e4-6818-4f7a-915c-2e25c19f0acd), the value provided in this field must meet those requirements. These requirements can be retrieved by calling the [Get Account Settings API](https://marketplace.zoom.us/docs/api-reference/zoom-api/accounts/accountsettings) and referring to the `password_requirement` field present in the `security` object.",
"type": "text"
},
{
"key": "options",
"value": "{\"share_rc\":false,\"room_connector_list\":[\"ea dolore nisi magna\",\"in proident ut\"],\"share_mc\":false,\"meeting_connector_list\":[\"irure ad\",\"laborum\"],\"pay_mode\":\"master\",\"billing_auto_renew\":true}",
"description": "Account options object.",
"type": "text"
},
{
"key": "account_name",
"value": "aute sint ullamco",
"description": "Name of the account. If you do not provide a value for this field, by default, the value will be set as a concatenation of \"first_name\" and \"last_name\". ",
"type": "text"
},
{
"key": "sub_reseller_id",
"value": "eiusmod labore aliquip",
"description": "The sub-reseller's ID.\n\nIf you do not provide this field in the payload, a new subaccount will be created for the requested account.",
"type": "text"
}
]
},
"url": {
"raw": "{{baseUrl}}/accounts",
"host": [
"{{baseUrl}}"
],
"path": [
"accounts"
]
}
},
"status": "Bad Request",
"code": 400,
"_postman_previewlanguage": "text",
"header": [
{
"key": "Content-Type",
"value": "text/plain"
}
],
"cookie": [
],
"body": ""
},
{
"name": "**HTTP Status Code:** `409`<br>\n**Error Code:** `1005`<br>\nEmail $email has already been used.",
"originalRequest": {
"method": "POST",
"header": [
{
"description": "Added as a part of security scheme: oauth2",
"key": "Authorization",
"value": "<token>"
}
],
"body": {
"mode": "formdata",
"formdata": [
{
"key": "first_name",
"value": "Ut",
"description": "(Required) User's first name.",
"type": "text"
},
{
"key": "last_name",
"value": "do mollit",
"description": "(Required) User's last name.",
"type": "text"
},
{
"key": "email",
"value": "esse Duis",
"description": "(Required) User's email address.",
"type": "text"
},
{
"key": "password",
"value": "Duis id elit dolor",
"description": "(Required) User's password.\n\n**Note:** If the account owner or admin has enabled [enhanced password requirements](https://support.zoom.us/hc/en-us/articles/360034675592-Advanced-security-settings#h_fa9186e4-6818-4f7a-915c-2e25c19f0acd), the value provided in this field must meet those requirements. These requirements can be retrieved by calling the [Get Account Settings API](https://marketplace.zoom.us/docs/api-reference/zoom-api/accounts/accountsettings) and referring to the `password_requirement` field present in the `security` object.",
"type": "text"
},
{
"key": "options",
"value": "{\"share_rc\":false,\"room_connector_list\":[\"ea dolore nisi magna\",\"in proident ut\"],\"share_mc\":false,\"meeting_connector_list\":[\"irure ad\",\"laborum\"],\"pay_mode\":\"master\",\"billing_auto_renew\":true}",
"description": "Account options object.",
"type": "text"
},
{
"key": "account_name",
"value": "aute sint ullamco",
"description": "Name of the account. If you do not provide a value for this field, by default, the value will be set as a concatenation of \"first_name\" and \"last_name\". ",
"type": "text"
},
{
"key": "sub_reseller_id",
"value": "eiusmod labore aliquip",
"description": "The sub-reseller's ID.\n\nIf you do not provide this field in the payload, a new subaccount will be created for the requested account.",
"type": "text"
}
]
},
"url": {
"raw": "{{baseUrl}}/accounts",
"host": [
"{{baseUrl}}"
],
"path": [
"accounts"
]
}
},
"status": "Conflict",
"code": 409,
"_postman_previewlanguage": "text",
"header": [
{
"key": "Content-Type",
"value": "text/plain"
}
],
"cookie": [
],
"body": ""
}
]
}
