Set custom desktop button icon

Set main screen icon image for proper button

• Supports png, jpeg, jpg image file with any resolution. Recommended resolution for icon is 500x500
• Maximum image size is 5 Mb
• This feature is available only in AA-14FB panel

Query Parameters

• code string required

  Possible values: [pincode, recognition, concierge, call, contacts]

  Application type used to change desktop button icon

application/octet-stream

Request Body required

• string binary

  Image upload model

Responses

• 200
• 400
• 401
• 403
• 404

---

OK

application/json

• Schema
• Example (from schema)
• Example

---

Schema

• icon query

  Path to the desktop button icon

{
  "icon": "/api/v1/files?imagePath=button-concierge-default.png"
}

{
  "icon": "/api/v1/files?imagePath=button-concierge-custom.png"
}

• Wrong image file
• Image size is too big
• Wrong code

application/json

• Schema
• Example (from schema)
• Wrong file
• Image is to big
• Wrong type

---

Schema

• error string

  Error message

{
  "error": "Wrong JSON body"
}

{
  "error": "Wrong image file"
}

{
  "error": "Image size is too big"
}

{
  "error": "Wrong application"
}

Unauthorized request. Log In

application/json

• Schema
• Example (from schema)
• Log In

---

Schema

• error string

  Error message

{
  "error": "Log In"
}

{
  "error": "Log In"
}

Administrator rights required. You are currently logged in with different user account. Log In with administrator rights

application/json

• Schema
• Example (from schema)
• Admin Rights Required

---

Schema

• error string

  Error message

{
  "error": "Administrator rights required"
}

{
  "error": "Administrator rights required"
}

This feature is disabled on your device

Loading...