Webex · Schema

deleteImageRequestObject

CallingCollaborationCommunicationEnterpriseMessagingVideo Conferencing

Properties

Name Type Description
fileName string The name of the image file to be deleted.
forceDelete boolean Flag to force delete the image. When `forceDelete` = true, if any device, location, or org level custom background URL is configured with the `backgroundImageURL` containing the filename being deleted
View JSON Schema on GitHub

JSON Schema

webex-deleteimagerequestobject-schema.json Raw ↑ 
{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "#/components/schemas/deleteImageRequestObject",
  "title": "deleteImageRequestObject",
  "type": "object",
  "required": [
    "fileName"
  ],
  "properties": {
    "fileName": {
      "type": "string",
      "example": "CompanyLogoBlue",
      "description": "The name of the image file to be deleted."
    },
    "forceDelete": {
      "type": "boolean",
      "example": true,
      "description": "Flag to force delete the image. When `forceDelete` = true, if any device, location, or org level custom background URL is configured with the `backgroundImageURL` containing the filename being deleted, the background image is set to `None`."
    }
  }
}