Class Manager
DELETE /v1/files/for-entity/{entityId}/{purpose}

Delete all file with the given FilePurpose for the given entity (probably Course, Company, Student, or Staff)

Path parameters

  • entityId string Required

    Entity ID

  • purpose string Required

    File purpose

    Values are profile_picture, email_attachment, email_image, class_image, company_logo, or product_image.

Responses

  • 403 application/json

    Not authorized

    Hide response attributes Show response attributes object

    Error schema

    • statusCode number Required

      Status Code

    • messages array[string] Required

      List of error messages

    • exception object

      Exception
  • 404 application/json

    Not found

    Hide response attributes Show response attributes object

    Error schema

    • statusCode number Required

      Status Code

    • messages array[string] Required

      List of error messages

    • exception object

      Exception
  • 204

    Successful operation with no content

DELETE /v1/files/for-entity/{entityId}/{purpose} 
curl \
 --request DELETE 'https://api.classmanager.io/v1/files/for-entity/cls_xxxxxxxxxxx/class-image'
Response examples (403) 
{
  "statusCode": 42.0,
  "messages": [
    "string"
  ],
  "exception": {}
}
Response examples (404) 
{
  "statusCode": 42.0,
  "messages": [
    "string"
  ],
  "exception": {}
}