Avatar API
Last updated: August 28, 2026
Housing.Cloud offers an API that enables an Institution to send image data to be stored as a Profile's Avatar. The image data will be securely stored in Housing.Cloud infrastructure.
General Details:
- Endpoint:
/api/attachments/profile - Authorization Header:
x-api-key - Supported HTTP Methods:
POST - Version:
v1
Data Model:
This is the expected JSON format included in the POST request
| Field Name | Data Type | Notes |
| fileContents | string (base64) | Max file size is 10mb. Supported file formats: jpg and png
|
| sisId | string | |
| isPublic | boolean | Flag to indicate whether the Avatar is visible in the Student Portal* |
| uploaderId | number (optional) | The Housing.Cloud Profile ID of the person executing the upload |
Notes:
- * We typically recommend that an Institution sets
isPublictofalse, such that only Admins will ever see the student's provided Avatar.