Chilkat Online Tools

PowerBuilder / Zoom API / Delete Virtual Background files

Back to Collection Items

integer li_rc
oleobject loo_Http
integer li_Success
oleobject loo_Resp
integer li_RespStatusCode

// This example assumes the Chilkat API to have been previously unlocked.
// See Global Unlock Sample for sample code.

loo_Http = create oleobject
// Use "Chilkat_9_5_0.Http" for versions of Chilkat < 10.0.0
li_rc = loo_Http.ConnectToNewObject("Chilkat.Http")
if li_rc < 0 then
    destroy loo_Http
    MessageBox("Error","Connecting to COM object failed")
    return
end if

// Adds the "Authorization: Bearer <access_token>" header.
loo_Http.AuthToken = "<access_token>"

loo_Resp = loo_Http.QuickRequest("DELETE","reprehenderit")
if loo_Http.LastMethodSuccess = 0 then
    Write-Debug loo_Http.LastErrorText
    destroy loo_Http
    return
end if

li_RespStatusCode = loo_Resp.StatusCode
Write-Debug "Response Status Code = " + string(li_RespStatusCode)
if li_RespStatusCode <> 204 then
    Write-Debug "Response Header:"
    Write-Debug loo_Resp.Header
    Write-Debug "Response Body:"
    Write-Debug loo_Resp.BodyStr
    Write-Debug "Failed."
    destroy loo_Resp
    destroy loo_Http
    return
end if

destroy loo_Resp
Write-Debug "Success."


destroy loo_Http

Curl Command

curl -X DELETE
	-H "Authorization: Bearer <access_token>"
https://api.zoom.us/v2/groups/:groupId/settings/virtual_backgrounds?file_ids=quis officia in reprehenderit

Postman Collection Item JSON

{
  "name": "Delete Virtual Background files",
  "request": {
    "method": "DELETE",
    "header": [
    ],
    "url": {
      "raw": "{{baseUrl}}/groups/:groupId/settings/virtual_backgrounds?file_ids=quis officia in reprehenderit",
      "host": [
        "{{baseUrl}}"
      ],
      "path": [
        "groups",
        ":groupId",
        "settings",
        "virtual_backgrounds"
      ],
      "query": [
        {
          "key": "file_ids",
          "value": "quis officia in reprehenderit",
          "description": "A comma-separated list of the file IDs to delete."
        }
      ],
      "variable": [
        {
          "key": "groupId",
          "value": "quis officia in reprehenderit",
          "description": "(Required) The group ID. To get a group's ID, use the [**List groups**](https://marketplace.zoom.us/docs/api-reference/zoom-api/groups/groups) API."
        }
      ]
    },
    "description": "Use this API to delete a group's [Virtual Background files](https://support.zoom.us/hc/en-us/articles/210707503-Virtual-Background#h_01EJF3YFEWGT8YA0ZJ079JEDQE). \n\n **Scopes:** `group:write:admin` <br> **[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `Light` \n\n**Prerequisites:** \n* The [Virtual Background feature](https://support.zoom.us/hc/en-us/articles/210707503-Virtual-Background#h_2ef28080-fce9-4ac2-b567-dc958afab1b7) must be enabled on the account."
  },
  "response": [
    {
      "name": "**HTTP Status Code:** `204` <br>\n* No content. \n* Deleted.",
      "originalRequest": {
        "method": "DELETE",
        "header": [
          {
            "description": "Added as a part of security scheme: oauth2",
            "key": "Authorization",
            "value": "<token>"
          }
        ],
        "url": {
          "raw": "{{baseUrl}}/groups/:groupId/settings/virtual_backgrounds?file_ids=quis officia in reprehenderit",
          "host": [
            "{{baseUrl}}"
          ],
          "path": [
            "groups",
            ":groupId",
            "settings",
            "virtual_backgrounds"
          ],
          "query": [
            {
              "key": "file_ids",
              "value": "quis officia in reprehenderit"
            }
          ],
          "variable": [
            {
              "key": "groupId",
              "value": "quis officia in reprehenderit",
              "description": "(Required) The group ID. To get a group's ID, use the [**List groups**](https://marketplace.zoom.us/docs/api-reference/zoom-api/groups/groups) API."
            }
          ]
        }
      },
      "status": "No Content",
      "code": 204,
      "_postman_previewlanguage": "text",
      "header": [
        {
          "key": "Content-Type",
          "value": "text/plain"
        }
      ],
      "cookie": [
      ],
      "body": ""
    },
    {
      "name": "**HTTP Status Code:** `400` <br>\n Bad Request \n\n **Error Code:** `300` <br>\n* Invalid parameter: {file_ids} \n* Group member not found.",
      "originalRequest": {
        "method": "DELETE",
        "header": [
          {
            "description": "Added as a part of security scheme: oauth2",
            "key": "Authorization",
            "value": "<token>"
          }
        ],
        "url": {
          "raw": "{{baseUrl}}/groups/:groupId/settings/virtual_backgrounds?file_ids=quis officia in reprehenderit",
          "host": [
            "{{baseUrl}}"
          ],
          "path": [
            "groups",
            ":groupId",
            "settings",
            "virtual_backgrounds"
          ],
          "query": [
            {
              "key": "file_ids",
              "value": "quis officia in reprehenderit"
            }
          ],
          "variable": [
            {
              "key": "groupId",
              "value": "quis officia in reprehenderit",
              "description": "(Required) The group ID. To get a group's ID, use the [**List groups**](https://marketplace.zoom.us/docs/api-reference/zoom-api/groups/groups) API."
            }
          ]
        }
      },
      "status": "Bad Request",
      "code": 400,
      "_postman_previewlanguage": "text",
      "header": [
        {
          "key": "Content-Type",
          "value": "text/plain"
        }
      ],
      "cookie": [
      ],
      "body": ""
    },
    {
      "name": "**HTTP Status Code:** `404` <br>\n Not Found \n\n **Error Code:** `4130` <br>\n A group with this {groupId} does not exist.",
      "originalRequest": {
        "method": "DELETE",
        "header": [
          {
            "description": "Added as a part of security scheme: oauth2",
            "key": "Authorization",
            "value": "<token>"
          }
        ],
        "url": {
          "raw": "{{baseUrl}}/groups/:groupId/settings/virtual_backgrounds?file_ids=quis officia in reprehenderit",
          "host": [
            "{{baseUrl}}"
          ],
          "path": [
            "groups",
            ":groupId",
            "settings",
            "virtual_backgrounds"
          ],
          "query": [
            {
              "key": "file_ids",
              "value": "quis officia in reprehenderit"
            }
          ],
          "variable": [
            {
              "key": "groupId",
              "value": "quis officia in reprehenderit",
              "description": "(Required) The group ID. To get a group's ID, use the [**List groups**](https://marketplace.zoom.us/docs/api-reference/zoom-api/groups/groups) API."
            }
          ]
        }
      },
      "status": "Not Found",
      "code": 404,
      "_postman_previewlanguage": "text",
      "header": [
        {
          "key": "Content-Type",
          "value": "text/plain"
        }
      ],
      "cookie": [
      ],
      "body": ""
    }
  ]
}