The put upload user profile photo will upload a profile photo for a user.
Request
Request URI
| Method | Request URI |
|---|---|
| PUT | https://{company-name}.helloid.com/api/v1/users/{userGuid}/photo |
Request parameters
| Parameter | Description |
|---|---|
| {userGuid} | The user guid of the user you want to upload a photo for. |
Request headers
| Parameter | Description |
|---|---|
| Content-type | Required. Must be set to application/json |
Sample request body
{
{
"profilePhotoBase64": "iVBORw0KGgoAAAANSUhEUgAAAEEAAABBCAYAAACO98lFAAAAAXNSR0IArs4c6QAAAARnQU1BAACxjwv8YQUAAAAJcEhZcwAADsMAAA7DAcdvqGQAAAH+… "
}
}
Request body parameters
| Parameter | Description | Required/Optional | Default value |
|---|---|---|---|
| {profilePhotoBase64} | The image base64 encoded string value. |
Response
Response status
| Code | Description |
|---|---|
| 200(OK) | Indicates that the operation was successful and the resource is created. |
| 400(BAD REQUEST) | Indicates that the operation was not successful. The content type was incorrect or the request body was malformed. |
| 401(UNAUTHORIZED) | Indicates that no authentication header was given or the api key and secret were invalid. If the api key and secret were valid check the configuration in your portal, it is possibilty these were IP restricted or are disabled. |
| 404(NOT FOUND) | The operation was not successful. The <Type> has not been found. |
Please also see error result.
Please also see common HTTP status codes.
Example request with cURL
Replace placeholder values surrounded by { } with the actual values.
curl -u {api-key}:{api-secret} -X PUT https://{company-name}.helloid.com/api/v1/users/{userGuid}/photo
-H "Content-Type:application/json" -d "{
"profilePhotoBase64" : {profilePhotoBase64}
}
"