Class Manager
POST /v1/avatars

Create an avatar for the entity.

application/json

Body

Request for creating or updating an avatar for the entity.

  • entityId string

    Entity ID

  • path string

    Uploaded profile picture image path

Responses

  • 200 application/json

    successful operation

    Hide response attributes Show response attributes object
    • id string Required

      File ID

    • companyId string Required

      Company ID

    • entityId string Required

      Entity ID

    • name string Required

      Name

    • purpose string Required

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

    • url string Required

      Url
  • 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
  • 422 application/json

    Validation error

    Hide response attributes Show response attributes object
    • statusCode number Required

      Status Code

    • messages array[string] Required

      List of error messages

    • exception object

      Exception
POST /v1/avatars 
curl \
 --request POST 'https://classmanager.test/v1/avatars' \
 --header "Content-Type: application/json" \
 --data '{"entityId":"stf_xxxxxxxxxxxxx","path":"uploads/stu_xxxxx/photo-1.jpg"}'
Request examples 
{
  "entityId": "stf_xxxxxxxxxxxxx",
  "path": "uploads/stu_xxxxx/photo-1.jpg"
}
Response examples (200) 
{
  "id": "file_xxxxxxxxxxxxxxxxxxxxxxxxxx",
  "companyId": "co_xxxxxxxxxxxxxxxxxxxxxxxxxx",
  "entityId": "stf_123123123123",
  "name": "image.jpg",
  "purpose": "profile_picture",
  "url": "https://example.com/image.jpg"
}
Response examples (403) 
{
  "statusCode": 42.0,
  "messages": [
    "string"
  ],
  "exception": {}
}
Response examples (422) 
{
  "statusCode": 42.0,
  "messages": [
    "string"
  ],
  "exception": {}
}